@openfin/node-adapter 35.78.1 → 35.78.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/out/node-adapter-alpha.d.ts +1274 -2111
- package/out/node-adapter-beta.d.ts +1274 -2111
- package/out/node-adapter-public.d.ts +1274 -2111
- package/out/node-adapter.d.ts +1319 -2344
- package/out/node-adapter.js +66 -1397
- package/package.json +3 -2
- package/resources/win/OpenFinRVM.exe +0 -0
package/out/node-adapter.d.ts
CHANGED
@@ -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 =
|
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
|
*/
|
@@ -184,100 +199,6 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
|
|
184
199
|
*/
|
185
200
|
constructor(wire: Transport, identity: OpenFin.ApplicationIdentity);
|
186
201
|
private windowListFromIdentityList;
|
187
|
-
/**
|
188
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
189
|
-
* @param eventType - The type of the event.
|
190
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
191
|
-
* @param options - Option to support event timestamps.
|
192
|
-
*
|
193
|
-
* @function addListener
|
194
|
-
* @memberof Application
|
195
|
-
* @instance
|
196
|
-
* @tutorial Application.EventEmitter
|
197
|
-
*/
|
198
|
-
/**
|
199
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
200
|
-
* @param eventType - The type of the event.
|
201
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
202
|
-
* @param options - Option to support event timestamps.
|
203
|
-
*
|
204
|
-
* @function on
|
205
|
-
* @memberof Application
|
206
|
-
* @instance
|
207
|
-
* @tutorial Application.EventEmitter
|
208
|
-
*/
|
209
|
-
/**
|
210
|
-
* 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.
|
211
|
-
* @param eventType - The type of the event.
|
212
|
-
* @param listener - The callback function.
|
213
|
-
* @param options - Option to support event timestamps.
|
214
|
-
*
|
215
|
-
* @function once
|
216
|
-
* @memberof Application
|
217
|
-
* @instance
|
218
|
-
* @tutorial Application.EventEmitter
|
219
|
-
*/
|
220
|
-
/**
|
221
|
-
* Adds a listener to the beginning of the listeners array for the specified event.
|
222
|
-
* @param eventType - The type of the event.
|
223
|
-
* @param listener - The callback function.
|
224
|
-
* @param options - Option to support event timestamps.
|
225
|
-
*
|
226
|
-
* @function prependListener
|
227
|
-
* @memberof Application
|
228
|
-
* @instance
|
229
|
-
* @tutorial Application.EventEmitter
|
230
|
-
*/
|
231
|
-
/**
|
232
|
-
* 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.
|
233
|
-
* The listener is added to the beginning of the listeners array.
|
234
|
-
* @param eventType - The type of the event.
|
235
|
-
* @param listener - The callback function.
|
236
|
-
* @param options - Option to support event timestamps.
|
237
|
-
*
|
238
|
-
* @function prependOnceListener
|
239
|
-
* @memberof Application
|
240
|
-
* @instance
|
241
|
-
* @tutorial Application.EventEmitter
|
242
|
-
*/
|
243
|
-
/**
|
244
|
-
* Remove a listener from the listener array for the specified event.
|
245
|
-
* Caution: Calling this method changes the array indices in the listener array behind the listener.
|
246
|
-
* @param eventType - The type of the event.
|
247
|
-
* @param listener - The callback function.
|
248
|
-
* @param options - Option to support event timestamps.
|
249
|
-
*
|
250
|
-
* @function removeListener
|
251
|
-
* @memberof Application
|
252
|
-
* @instance
|
253
|
-
* @tutorial Application.EventEmitter
|
254
|
-
*/
|
255
|
-
/**
|
256
|
-
* Removes all listeners, or those of the specified event.
|
257
|
-
* @param eventType - The type of the event.
|
258
|
-
*
|
259
|
-
* @function removeAllListeners
|
260
|
-
* @memberof Application
|
261
|
-
* @instance
|
262
|
-
* @tutorial Application.EventEmitter
|
263
|
-
*/
|
264
|
-
/**
|
265
|
-
* JumpListCategory interface
|
266
|
-
* @typedef { object } JumpListCategory@typedef { object } JumpListCategory
|
267
|
-
* @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.
|
268
|
-
* @property { JumpListItem[] } items Array of JumpListItem objects
|
269
|
-
*/
|
270
|
-
/**
|
271
|
-
* @PORTED
|
272
|
-
* JumpListItem interface
|
273
|
-
* @typedef { object } JumpListItem@typedef { object } JumpListItem
|
274
|
-
* @property { string } type One of the following: "task" or "separator". Defaults to task.
|
275
|
-
* @property { string } title The text to be displayed for the JumpList Item. Should only be set if type is "task".
|
276
|
-
* @property { string } description Description of the task (displayed in a tooltip). Should only be set if type is "task".
|
277
|
-
* @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.
|
278
|
-
* @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).
|
279
|
-
* @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.
|
280
|
-
*/
|
281
202
|
/**
|
282
203
|
* Determines if the application is currently running.
|
283
204
|
*
|
@@ -862,19 +783,15 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
|
|
862
783
|
}
|
863
784
|
|
864
785
|
/**
|
865
|
-
*
|
866
|
-
* @interface
|
786
|
+
* @deprecated Renamed to {@link ConnectedEvent}.
|
867
787
|
*/
|
868
|
-
declare type ApplicationConnectedEvent =
|
869
|
-
topic: 'application';
|
870
|
-
type: 'connected';
|
871
|
-
};
|
788
|
+
declare type ApplicationConnectedEvent = ConnectedEvent_2;
|
872
789
|
|
873
790
|
/**
|
874
791
|
* Generated when an application is created.
|
875
792
|
* @interface
|
876
793
|
*/
|
877
|
-
declare type ApplicationCreatedEvent =
|
794
|
+
declare type ApplicationCreatedEvent = BaseEvent_8 & BaseEvents.IdentityEvent & {
|
878
795
|
type: 'application-created';
|
879
796
|
};
|
880
797
|
|
@@ -898,17 +815,15 @@ declare type ApplicationCreationOptions = Partial<ApplicationOptions> & {
|
|
898
815
|
};
|
899
816
|
|
900
817
|
/**
|
901
|
-
*
|
902
|
-
* discriminated by {@link ApplicationEvent.type | their type}. Event payloads unique to `Application` can be found
|
903
|
-
* under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
904
|
-
* from which they propagate).
|
818
|
+
* @deprecated Renamed to {@link Event}.
|
905
819
|
*/
|
906
|
-
declare type ApplicationEvent =
|
820
|
+
declare type ApplicationEvent = Event_3;
|
907
821
|
|
908
822
|
declare type ApplicationEvent_2 = Events.ApplicationEvents.ApplicationEvent;
|
909
823
|
|
910
824
|
declare namespace ApplicationEvents {
|
911
825
|
export {
|
826
|
+
BaseEvent_3 as BaseEvent,
|
912
827
|
BaseApplicationEvent,
|
913
828
|
CrashedEvent,
|
914
829
|
FileDownloadLocationChangedEvent,
|
@@ -922,6 +837,7 @@ declare namespace ApplicationEvents {
|
|
922
837
|
WindowStartLoadEvent,
|
923
838
|
ApplicationWindowEvent,
|
924
839
|
ClosedEvent,
|
840
|
+
ConnectedEvent_2 as ConnectedEvent,
|
925
841
|
ApplicationConnectedEvent,
|
926
842
|
InitializedEvent,
|
927
843
|
ManifestChangedEvent,
|
@@ -929,19 +845,24 @@ declare namespace ApplicationEvents {
|
|
929
845
|
RespondingEvent,
|
930
846
|
StartedEvent,
|
931
847
|
ApplicationSourcedEvent,
|
848
|
+
ApplicationSourcedEventType,
|
849
|
+
Event_3 as Event,
|
932
850
|
ApplicationEvent,
|
851
|
+
EventType_3 as EventType,
|
933
852
|
ApplicationEventType,
|
853
|
+
PropagatedEvent_4 as PropagatedEvent,
|
934
854
|
PropagatedApplicationEvent,
|
855
|
+
PropagatedEventType_3 as PropagatedEventType,
|
935
856
|
PropagatedApplicationEventType,
|
936
|
-
|
937
|
-
ByType
|
857
|
+
Payload_4 as Payload,
|
858
|
+
ByType_3 as ByType
|
938
859
|
}
|
939
860
|
}
|
940
861
|
|
941
862
|
/**
|
942
|
-
*
|
863
|
+
* @deprecated Renamed to {@link EventType}.
|
943
864
|
*/
|
944
|
-
declare type ApplicationEventType =
|
865
|
+
declare type ApplicationEventType = EventType_3;
|
945
866
|
|
946
867
|
declare type ApplicationIdentity = OpenFin.ApplicationIdentity;
|
947
868
|
|
@@ -1294,9 +1215,13 @@ declare type ApplicationPermissions = {
|
|
1294
1215
|
* A union of all events that emit natively on the `Application` topic, i.e. excluding those that propagate
|
1295
1216
|
* from {@link OpenFin.ViewEvents} or {@link OpenFin.WindowEvents}. Due to details in propagation prefixing rules,
|
1296
1217
|
* does not include {@link ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}.
|
1297
|
-
*
|
1298
1218
|
*/
|
1299
|
-
declare type ApplicationSourcedEvent = ClosedEvent |
|
1219
|
+
declare type ApplicationSourcedEvent = ClosedEvent | ConnectedEvent_2 | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent_2 | StartedEvent | TrayIconClickedEvent | FileDownloadLocationChangedEvent;
|
1220
|
+
|
1221
|
+
/**
|
1222
|
+
* Union of possible type values for an {@link ApplicationSourcedEvent}.
|
1223
|
+
*/
|
1224
|
+
declare type ApplicationSourcedEventType = ApplicationSourcedEvent['type'];
|
1300
1225
|
|
1301
1226
|
declare type ApplicationState = OpenFin.ApplicationState;
|
1302
1227
|
|
@@ -1612,7 +1537,7 @@ declare interface AuthorizationPayload {
|
|
1612
1537
|
* ```
|
1613
1538
|
* @interface
|
1614
1539
|
*/
|
1615
|
-
declare type AuthRequestedEvent =
|
1540
|
+
declare type AuthRequestedEvent = BaseEvent_5 & {
|
1616
1541
|
type: 'auth-requested';
|
1617
1542
|
authInfo: {
|
1618
1543
|
host: string;
|
@@ -1680,21 +1605,9 @@ declare class Base {
|
|
1680
1605
|
}
|
1681
1606
|
|
1682
1607
|
/**
|
1683
|
-
*
|
1684
|
-
* @interface
|
1685
|
-
*/
|
1686
|
-
declare type BaseApplicationEvent = NamedEvent & {
|
1687
|
-
topic: `application`;
|
1688
|
-
};
|
1689
|
-
|
1690
|
-
/**
|
1691
|
-
* A base Channel event.
|
1692
|
-
* @interface
|
1608
|
+
* @deprecated Renamed to {@link BaseEvent}.
|
1693
1609
|
*/
|
1694
|
-
declare type
|
1695
|
-
channelName: string;
|
1696
|
-
channelId: string;
|
1697
|
-
};
|
1610
|
+
declare type BaseApplicationEvent = BaseEvent_3;
|
1698
1611
|
|
1699
1612
|
/**
|
1700
1613
|
* @interface
|
@@ -1763,10 +1676,70 @@ declare type BaseEvent = {
|
|
1763
1676
|
type: string;
|
1764
1677
|
};
|
1765
1678
|
|
1766
|
-
|
1679
|
+
/**
|
1680
|
+
* A base Channel event.
|
1681
|
+
* @interface
|
1682
|
+
*/
|
1683
|
+
declare type BaseEvent_2 = NamedEvent & {
|
1684
|
+
channelName: string;
|
1685
|
+
channelId: string;
|
1686
|
+
};
|
1687
|
+
|
1688
|
+
/**
|
1689
|
+
* Base type for events emitting on the `application` topic
|
1690
|
+
* @interface
|
1691
|
+
*/
|
1692
|
+
declare type BaseEvent_3 = BaseEvents.NamedEvent & {
|
1693
|
+
topic: `application`;
|
1694
|
+
};
|
1695
|
+
|
1696
|
+
/**
|
1697
|
+
* Base type for events emitting on the `view` topic
|
1698
|
+
* @interface
|
1699
|
+
*/
|
1700
|
+
declare type BaseEvent_4 = BaseEvents.NamedEvent & {
|
1701
|
+
topic: 'view';
|
1702
|
+
target: OpenFin.Identity;
|
1703
|
+
};
|
1704
|
+
|
1705
|
+
/**
|
1706
|
+
* Base type for events emitting on the `window` topic
|
1707
|
+
* @interface
|
1708
|
+
*/
|
1709
|
+
declare type BaseEvent_5 = BaseEvents.NamedEvent & {
|
1710
|
+
topic: 'window';
|
1711
|
+
};
|
1712
|
+
|
1713
|
+
/**
|
1714
|
+
* Base type for events emitting on the `externalapplication` topic
|
1715
|
+
* @interface
|
1716
|
+
*/
|
1717
|
+
declare type BaseEvent_6 = BaseEvents.BaseEvent & {
|
1718
|
+
topic: 'externalapplication';
|
1719
|
+
};
|
1720
|
+
|
1721
|
+
/**
|
1722
|
+
* The base frame event.
|
1723
|
+
* @interface
|
1724
|
+
*/
|
1725
|
+
declare type BaseEvent_7 = NamedEvent & {
|
1726
|
+
entityType: 'iframe';
|
1727
|
+
frameName: string;
|
1728
|
+
};
|
1729
|
+
|
1730
|
+
/**
|
1731
|
+
* Base type for events emitting on the `system` topic
|
1732
|
+
* @interface
|
1733
|
+
*/
|
1734
|
+
declare type BaseEvent_8 = BaseEvents.BaseEvent & {
|
1735
|
+
topic: 'system';
|
1736
|
+
};
|
1737
|
+
|
1738
|
+
declare type BaseEvent_9 = Events.BaseEvents.BaseEvent;
|
1767
1739
|
|
1768
1740
|
declare namespace BaseEvents {
|
1769
1741
|
export {
|
1742
|
+
NotCloseRequested,
|
1770
1743
|
PropagatedEventType,
|
1771
1744
|
PropagatedEvent,
|
1772
1745
|
EventHandler,
|
@@ -1777,21 +1750,14 @@ declare namespace BaseEvents {
|
|
1777
1750
|
}
|
1778
1751
|
|
1779
1752
|
/**
|
1780
|
-
*
|
1781
|
-
* @interface
|
1753
|
+
* @deprecated Renamed to {@link BaseEvent}.
|
1782
1754
|
*/
|
1783
|
-
declare type BaseExternalApplicationEvent =
|
1784
|
-
topic: 'externalapplication';
|
1785
|
-
};
|
1755
|
+
declare type BaseExternalApplicationEvent = BaseEvent_6;
|
1786
1756
|
|
1787
1757
|
/**
|
1788
|
-
*
|
1789
|
-
* @interface
|
1758
|
+
* @deprecated Renamed to {@link BaseEvent}.
|
1790
1759
|
*/
|
1791
|
-
declare type BaseFrameEvent =
|
1792
|
-
entityType: 'iframe';
|
1793
|
-
frameName: string;
|
1794
|
-
};
|
1760
|
+
declare type BaseFrameEvent = BaseEvent_7;
|
1795
1761
|
|
1796
1762
|
declare type BaseLoadFailedEvent = NamedEvent & {
|
1797
1763
|
errorCode: number;
|
@@ -1800,35 +1766,20 @@ declare type BaseLoadFailedEvent = NamedEvent & {
|
|
1800
1766
|
isMainFrame: boolean;
|
1801
1767
|
};
|
1802
1768
|
|
1803
|
-
/**
|
1804
|
-
* Base type for events emitting on the `system` topic
|
1805
|
-
* @interface
|
1806
|
-
*/
|
1807
|
-
declare type BaseSystemEvent = BaseEvent & {
|
1808
|
-
topic: 'system';
|
1809
|
-
};
|
1810
|
-
|
1811
1769
|
declare type BaseUrlEvent = NamedEvent & {
|
1812
1770
|
type: 'url-changed';
|
1813
1771
|
url: string;
|
1814
1772
|
};
|
1815
1773
|
|
1816
1774
|
/**
|
1817
|
-
*
|
1818
|
-
* @interface
|
1775
|
+
* @deprecated Renamed to {@link BaseEvent}.
|
1819
1776
|
*/
|
1820
|
-
declare type BaseViewEvent =
|
1821
|
-
topic: 'view';
|
1822
|
-
target: OpenFin.Identity;
|
1823
|
-
};
|
1777
|
+
declare type BaseViewEvent = BaseEvent_4;
|
1824
1778
|
|
1825
1779
|
/**
|
1826
|
-
*
|
1827
|
-
* @interface
|
1780
|
+
* @deprecated Renamed to {@link BaseEvent}.
|
1828
1781
|
*/
|
1829
|
-
declare type BaseWindowEvent =
|
1830
|
-
topic: 'window';
|
1831
|
-
};
|
1782
|
+
declare type BaseWindowEvent = BaseEvent_5;
|
1832
1783
|
|
1833
1784
|
/**
|
1834
1785
|
* User decision of whether a Window or specific View should close when trying to prevent an unload.
|
@@ -1895,7 +1846,7 @@ declare type BoundsChangedEvent = BoundsChangeEvent & {
|
|
1895
1846
|
* A general bounds change event without event type.
|
1896
1847
|
* @interface
|
1897
1848
|
*/
|
1898
|
-
declare type BoundsChangeEvent =
|
1849
|
+
declare type BoundsChangeEvent = BaseEvent_5 & {
|
1899
1850
|
changeType: 0 | 1 | 2;
|
1900
1851
|
deferred: boolean;
|
1901
1852
|
height: number;
|
@@ -1967,76 +1918,76 @@ declare interface BrowserWindow {
|
|
1967
1918
|
}
|
1968
1919
|
|
1969
1920
|
/**
|
1970
|
-
* Extracts a single event type matching the given key from the {@link
|
1921
|
+
* Extracts a single event type matching the given key from the View {@link Event} union.
|
1971
1922
|
*
|
1972
1923
|
* Alias for {@link Payload}, which may read better in source.
|
1973
1924
|
*
|
1974
1925
|
* @typeParam Type String key specifying the event to extract
|
1975
1926
|
*/
|
1976
|
-
declare type ByType<Type extends
|
1927
|
+
declare type ByType<Type extends EventType> = Payload_2<Type>;
|
1977
1928
|
|
1978
1929
|
/**
|
1979
|
-
* Extracts a single event type matching the given key from the {@link
|
1930
|
+
* Extracts a single event type matching the given key from the Window {@link Event} union.
|
1980
1931
|
*
|
1981
1932
|
* Alias for {@link Payload}, which may read better in source.
|
1982
1933
|
*
|
1983
1934
|
* @typeParam Type String key specifying the event to extract
|
1984
1935
|
*/
|
1985
|
-
declare type ByType_2<Type extends
|
1936
|
+
declare type ByType_2<Type extends EventType_2> = Payload_3<Type>;
|
1986
1937
|
|
1987
1938
|
/**
|
1988
|
-
* Extracts a single event type matching the given key from the {@link
|
1939
|
+
* Extracts a single event type matching the given key from the Application {@link Event} union.
|
1989
1940
|
*
|
1990
1941
|
* Alias for {@link Payload}, which may read better in source.
|
1991
1942
|
*
|
1992
1943
|
* @typeParam Type String key specifying the event to extract
|
1993
1944
|
*/
|
1994
|
-
declare type ByType_3<Type extends
|
1945
|
+
declare type ByType_3<Type extends EventType_3> = Payload_4<Type>;
|
1995
1946
|
|
1996
1947
|
/**
|
1997
|
-
* Extracts a single event type matching the given key from the {@link
|
1948
|
+
* Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
|
1998
1949
|
*
|
1999
1950
|
* Alias for {@link Payload}, which may read better in source.
|
2000
1951
|
*
|
2001
1952
|
* @typeParam Type String key specifying the event to extract
|
2002
1953
|
*/
|
2003
|
-
declare type ByType_4<Type extends
|
1954
|
+
declare type ByType_4<Type extends EventType_4> = Payload_5<Type>;
|
2004
1955
|
|
2005
1956
|
/**
|
2006
|
-
* Extracts a single event type matching the given key from the {@link
|
1957
|
+
* Extracts a single event type matching the given key from the Frame {@link Event} union.
|
2007
1958
|
*
|
2008
1959
|
* Alias for {@link Payload}, which may read better in source.
|
2009
1960
|
*
|
2010
1961
|
* @typeParam Type String key specifying the event to extract
|
2011
1962
|
*/
|
2012
|
-
declare type ByType_5<Type extends
|
1963
|
+
declare type ByType_5<Type extends EventType_5> = Payload_6<Type>;
|
2013
1964
|
|
2014
1965
|
/**
|
2015
|
-
* Extracts a single event type matching the given key from the {@link
|
1966
|
+
* Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
|
2016
1967
|
*
|
2017
1968
|
* Alias for {@link Payload}, which may read better in source.
|
2018
1969
|
*
|
2019
1970
|
* @typeParam Type String key specifying the event to extract
|
2020
1971
|
*/
|
2021
|
-
declare type ByType_6<Type extends
|
1972
|
+
declare type ByType_6<Type extends EventType_6> = Payload_7<Type>;
|
2022
1973
|
|
2023
1974
|
/**
|
2024
|
-
* Extracts a single event type matching the given key from the {@link
|
1975
|
+
* Extracts a single event type matching the given key from the Platform {@link Event} union.
|
2025
1976
|
*
|
2026
1977
|
* Alias for {@link Payload}, which may read better in source.
|
2027
1978
|
*
|
2028
1979
|
* @typeParam Type String key specifying the event to extract
|
2029
1980
|
*/
|
2030
|
-
declare type ByType_7<Type extends
|
1981
|
+
declare type ByType_7<Type extends EventType_7> = Payload_8<Type>;
|
2031
1982
|
|
2032
1983
|
/**
|
2033
|
-
* Extracts a single event type matching the given key from the {@link
|
1984
|
+
* Extracts a single event type matching the given key from the System {@link Event} union.
|
2034
1985
|
*
|
2035
1986
|
* Alias for {@link Payload}, which may read better in source.
|
2036
1987
|
*
|
2037
1988
|
* @typeParam Type String key specifying the event to extract
|
2038
1989
|
*/
|
2039
|
-
declare type ByType_8<Type extends
|
1990
|
+
declare type ByType_8<Type extends EventType_8> = Payload_9<Type>;
|
2040
1991
|
|
2041
1992
|
/**
|
2042
1993
|
* Configuration for page capture.
|
@@ -2719,14 +2670,6 @@ declare type ChannelClientConnectionListener = (identity: ClientIdentity, connec
|
|
2719
2670
|
|
2720
2671
|
declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) => any;
|
2721
2672
|
|
2722
|
-
/**
|
2723
|
-
* Generated when a Channel client is connected.
|
2724
|
-
* @interface
|
2725
|
-
*/
|
2726
|
-
declare type ChannelConnectedEvent = BaseChannelEvent & {
|
2727
|
-
type: 'connected';
|
2728
|
-
};
|
2729
|
-
|
2730
2673
|
/**
|
2731
2674
|
* Options provided on a client connection to a channel.
|
2732
2675
|
*
|
@@ -2758,21 +2701,9 @@ declare type ChannelCreateOptions = {
|
|
2758
2701
|
};
|
2759
2702
|
|
2760
2703
|
/**
|
2761
|
-
*
|
2762
|
-
* @interface
|
2763
|
-
*/
|
2764
|
-
declare type ChannelDisconnectedEvent = BaseChannelEvent & {
|
2765
|
-
type: 'disconnected';
|
2766
|
-
};
|
2767
|
-
|
2768
|
-
/**
|
2769
|
-
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Channel}. Events are
|
2770
|
-
* discriminated by {@link ChannelEvent.type | their type}. Event payloads unique to `Channel` can be found
|
2771
|
-
* under the {@link OpenFin.ChannelEvents} namespace.
|
2704
|
+
* @deprecated Renamed to {@link Event}.
|
2772
2705
|
*/
|
2773
|
-
declare type ChannelEvent =
|
2774
|
-
topic: 'channel';
|
2775
|
-
} & (ChannelConnectedEvent | ChannelDisconnectedEvent);
|
2706
|
+
declare type ChannelEvent = Event_2;
|
2776
2707
|
|
2777
2708
|
declare type ChannelMiddleware = OpenFin.ChannelMiddleware;
|
2778
2709
|
|
@@ -3129,20 +3060,6 @@ declare type ClientInfo = Omit<ClientIdentity, 'isLocalEndpointId'> & {
|
|
3129
3060
|
connectionUrl: string;
|
3130
3061
|
};
|
3131
3062
|
|
3132
|
-
/**
|
3133
|
-
* @PORTED
|
3134
|
-
* WriteRequestType interface
|
3135
|
-
* @typedef { object } WriteRequestType@typedef { object } WriteRequestType
|
3136
|
-
* @property { string } data Data to be written
|
3137
|
-
* @property { string } [type] Clipboard Type
|
3138
|
-
*/
|
3139
|
-
/**
|
3140
|
-
* @PORTED
|
3141
|
-
* OpenFin.WriteAnyClipboardRequest interface
|
3142
|
-
* @typedef { object } OpenFin.WriteAnyClipboardRequest@typedef { object } OpenFin.WriteAnyClipboardRequest
|
3143
|
-
* @property { string } data Data to be written
|
3144
|
-
* @property { OpenFin.ClipboardSelectionType } [type] Clipboard Type defaults to 'clipboard', use 'selection' for linux
|
3145
|
-
*/
|
3146
3063
|
/**
|
3147
3064
|
* The Clipboard API allows reading and writing to the clipboard in multiple formats.
|
3148
3065
|
*
|
@@ -3310,11 +3227,19 @@ declare type ClipboardSelectionType = 'clipboard' | 'selection';
|
|
3310
3227
|
* Generated when an application is closed.
|
3311
3228
|
* @interface
|
3312
3229
|
*/
|
3313
|
-
declare type ClosedEvent = IdentityEvent & {
|
3230
|
+
declare type ClosedEvent = BaseEvents.IdentityEvent & {
|
3314
3231
|
topic: 'application';
|
3315
3232
|
type: 'closed';
|
3316
3233
|
};
|
3317
3234
|
|
3235
|
+
/**
|
3236
|
+
* Generated when a window has closed.
|
3237
|
+
* @interface
|
3238
|
+
*/
|
3239
|
+
declare type ClosedEvent_2 = BaseEvent_5 & {
|
3240
|
+
type: 'closed';
|
3241
|
+
};
|
3242
|
+
|
3318
3243
|
/**
|
3319
3244
|
* @interface
|
3320
3245
|
*/
|
@@ -3322,6 +3247,15 @@ declare type ClosedMenuResult = {
|
|
3322
3247
|
result: 'closed';
|
3323
3248
|
};
|
3324
3249
|
|
3250
|
+
/**
|
3251
|
+
* Generated when a window has been prevented from closing.
|
3252
|
+
* @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.
|
3253
|
+
* @interface
|
3254
|
+
*/
|
3255
|
+
declare type CloseRequestedEvent = BaseEvent_5 & {
|
3256
|
+
type: 'close-requested';
|
3257
|
+
};
|
3258
|
+
|
3325
3259
|
/**
|
3326
3260
|
* @interface
|
3327
3261
|
*/
|
@@ -3368,62 +3302,19 @@ declare interface CloseWindowPayload {
|
|
3368
3302
|
};
|
3369
3303
|
}
|
3370
3304
|
|
3305
|
+
/**
|
3306
|
+
* Generated when a window has initiated the closing routine.
|
3307
|
+
* @interface
|
3308
|
+
*/
|
3309
|
+
declare type ClosingEvent = BaseEvent_5 & {
|
3310
|
+
type: 'closing';
|
3311
|
+
};
|
3312
|
+
|
3371
3313
|
/**
|
3372
3314
|
* A ColumnOrRow is used to manage the state of Column and Rows within an OpenFin Layout.
|
3373
3315
|
*/
|
3374
3316
|
declare class ColumnOrRow extends LayoutNode {
|
3375
3317
|
#private;
|
3376
|
-
/**
|
3377
|
-
* Determines if this {@link ColumnOrRow} is the top level content item in the current layout.
|
3378
|
-
* @function isRoot
|
3379
|
-
* @memberof ColumnOrRow
|
3380
|
-
* @instance
|
3381
|
-
* @tutorial ColumnOrRow.isRoot
|
3382
|
-
* @returns Resolves true if this TabStack is the top level content item, or false if it is not.
|
3383
|
-
*/
|
3384
|
-
/**
|
3385
|
-
* Determines if this {@link ColumnOrRow} exists.
|
3386
|
-
* @function exists
|
3387
|
-
* @instance
|
3388
|
-
* @memberof ColumnOrRow
|
3389
|
-
* @tutorial ColumnOrRow.exists
|
3390
|
-
* @returns Resolves true if the TabStack exists, or false if it has been destroyed.
|
3391
|
-
*/
|
3392
|
-
/**
|
3393
|
-
* Retrieves the parent {@link ColumnOrRow} of this {@link ColumnOrRow}, if one exists.
|
3394
|
-
* @function getParent
|
3395
|
-
* @instance
|
3396
|
-
* @memberof ColumnOrRow
|
3397
|
-
* @tutorial ColumnOrRow.getParent
|
3398
|
-
* @returns Promise resolving with the {@link ColumnOrRow} that contains this item, or undefined if
|
3399
|
-
* this {@link ColumnOrRow}does not exist or is the root content item.
|
3400
|
-
*/
|
3401
|
-
/**
|
3402
|
-
* Returns all the adjacent stacks that share an edge with the given {@link ColumnOrRow}.
|
3403
|
-
* @function getAdjacentStacks
|
3404
|
-
* @instance
|
3405
|
-
* @memberof ColumnOrRow
|
3406
|
-
* @param {LayoutPosition} edge - Edge to check for any adjacent stacks.
|
3407
|
-
*
|
3408
|
-
* @tutorial ColumnOrRow.getAdjacentStacks
|
3409
|
-
*/
|
3410
|
-
/**
|
3411
|
-
* Given a list of view creation options or references and a layout position, creates a {@link TabStack} adjacent to the given {@link ColumnOrRow}
|
3412
|
-
*
|
3413
|
-
* Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
|
3414
|
-
* during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
|
3415
|
-
* This means the views you pass to createAdjacentStack() may not render in the order given by the array.
|
3416
|
-
* Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
|
3417
|
-
*
|
3418
|
-
* @function createAdjacentStack
|
3419
|
-
* @instance
|
3420
|
-
* @memberof ColumnOrRow
|
3421
|
-
* @param views - List of identities or view creation options of the views to include in the stack
|
3422
|
-
* @param options - Creation options.
|
3423
|
-
* @returns The created TabStack
|
3424
|
-
* @tutorial ColumnOrRow.createAdjacentStack
|
3425
|
-
* @experimental
|
3426
|
-
*/
|
3427
3318
|
/**
|
3428
3319
|
* @internal
|
3429
3320
|
*/
|
@@ -3505,6 +3396,39 @@ export declare function connect(config: ConnectConfig): Promise<Fin<'external co
|
|
3505
3396
|
|
3506
3397
|
declare type ConnectConfig = ExistingConnectConfig | NewConnectConfig | ExternalConfig;
|
3507
3398
|
|
3399
|
+
/**
|
3400
|
+
* Generated when a Channel client is connected.
|
3401
|
+
* @interface
|
3402
|
+
*/
|
3403
|
+
declare type ConnectedEvent = BaseEvent_2 & {
|
3404
|
+
type: 'connected';
|
3405
|
+
};
|
3406
|
+
|
3407
|
+
/**
|
3408
|
+
* Generated when an application has authenticated and is connected.
|
3409
|
+
* @interface
|
3410
|
+
*/
|
3411
|
+
declare type ConnectedEvent_2 = BaseEvents.IdentityEvent & {
|
3412
|
+
topic: 'application';
|
3413
|
+
type: 'connected';
|
3414
|
+
};
|
3415
|
+
|
3416
|
+
/**
|
3417
|
+
* Generated when an external application has authenticated and is connected.
|
3418
|
+
* @interface
|
3419
|
+
*/
|
3420
|
+
declare type ConnectedEvent_3 = BaseExternalApplicationEvent & {
|
3421
|
+
type: 'connected';
|
3422
|
+
};
|
3423
|
+
|
3424
|
+
/**
|
3425
|
+
* Generated when a frame is connected.
|
3426
|
+
* @interface
|
3427
|
+
*/
|
3428
|
+
declare type ConnectedEvent_4 = BaseFrameEvent & {
|
3429
|
+
type: 'connected';
|
3430
|
+
};
|
3431
|
+
|
3508
3432
|
declare type Constructor<T = {}> = new () => T;
|
3509
3433
|
|
3510
3434
|
declare type ConstructorOverride<T> = (Base: Constructor<T>) => Constructor<T>;
|
@@ -3515,6 +3439,10 @@ declare type ConstructorOverride<T> = (Base: Constructor<T>) => Constructor<T>;
|
|
3515
3439
|
* @interface
|
3516
3440
|
*/
|
3517
3441
|
declare type ConstViewOptions = {
|
3442
|
+
/**
|
3443
|
+
* Configurations for API injection.
|
3444
|
+
*/
|
3445
|
+
api: Api;
|
3518
3446
|
/**
|
3519
3447
|
* The name of the view.
|
3520
3448
|
*/
|
@@ -3663,7 +3591,7 @@ declare type ConstWindowOptions = {
|
|
3663
3591
|
/**
|
3664
3592
|
* @defaultValue true
|
3665
3593
|
*
|
3666
|
-
*
|
3594
|
+
* Setting this to false would keep the Window alive even if all its Views were closed.
|
3667
3595
|
* This is meant for advanced users and should be used with caution.
|
3668
3596
|
* Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
|
3669
3597
|
* Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
|
@@ -3673,7 +3601,8 @@ declare type ConstWindowOptions = {
|
|
3673
3601
|
/**
|
3674
3602
|
* @defaultValue 'all'
|
3675
3603
|
*
|
3676
|
-
*
|
3604
|
+
* When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
|
3605
|
+
+ * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
|
3677
3606
|
* **NOTE:** - This option is ignored in non-Platforms apps.
|
3678
3607
|
*/
|
3679
3608
|
viewsPreventingClose: 'all' | 'layout';
|
@@ -4246,7 +4175,7 @@ declare type Context_3 = {
|
|
4246
4175
|
* Generated when a window's context is updated via {@link Platform#setWindowContext Platform.setWindowContext}. Only available on windows in a Platform.
|
4247
4176
|
* @interface
|
4248
4177
|
*/
|
4249
|
-
declare type ContextChangedEvent =
|
4178
|
+
declare type ContextChangedEvent = BaseEvent_5 & {
|
4250
4179
|
type: 'context-changed';
|
4251
4180
|
context: any;
|
4252
4181
|
};
|
@@ -4398,7 +4327,7 @@ declare type CpuInfo = {
|
|
4398
4327
|
* Generated when an application has crashed.
|
4399
4328
|
* @interface
|
4400
4329
|
*/
|
4401
|
-
declare type CrashedEvent = IdentityEvent & {
|
4330
|
+
declare type CrashedEvent = BaseEvents.IdentityEvent & {
|
4402
4331
|
topic: 'application';
|
4403
4332
|
type: 'crashed';
|
4404
4333
|
reason: 'normal-termination' | 'abnormal-termination' | 'killed' | 'crashed' | 'still-running' | 'launch-failed' | 'out-of-memory' | 'integrity-failure';
|
@@ -4449,7 +4378,7 @@ declare type CrashReporterState = CrashReporterOptions & {
|
|
4449
4378
|
* Generated when a View is created.
|
4450
4379
|
* @interface
|
4451
4380
|
*/
|
4452
|
-
declare type CreatedEvent =
|
4381
|
+
declare type CreatedEvent = BaseEvent_4 & {
|
4453
4382
|
type: 'created';
|
4454
4383
|
};
|
4455
4384
|
|
@@ -4480,7 +4409,7 @@ declare type CreateViewPayload = {
|
|
4480
4409
|
/**
|
4481
4410
|
* @interface
|
4482
4411
|
*/
|
4483
|
-
declare type CreateViewTarget = LayoutIdentity & {
|
4412
|
+
declare type CreateViewTarget = (Identity_5 | LayoutIdentity) & {
|
4484
4413
|
/**
|
4485
4414
|
* If specified, view creation will not attach to a window and caller must
|
4486
4415
|
* insert the view into the layout explicitly
|
@@ -4608,7 +4537,7 @@ declare interface DesktopAgent_2 {
|
|
4608
4537
|
* Generated when the desktop icon is clicked while it's already running.
|
4609
4538
|
* @interface
|
4610
4539
|
*/
|
4611
|
-
declare type DesktopIconClickedEvent =
|
4540
|
+
declare type DesktopIconClickedEvent = BaseEvent_8 & {
|
4612
4541
|
type: 'desktop-icon-clicked';
|
4613
4542
|
};
|
4614
4543
|
|
@@ -4616,10 +4545,18 @@ declare type DesktopIconClickedEvent = BaseSystemEvent & {
|
|
4616
4545
|
* Generated when a View is destroyed.
|
4617
4546
|
* @interface
|
4618
4547
|
*/
|
4619
|
-
declare type DestroyedEvent =
|
4548
|
+
declare type DestroyedEvent = BaseEvent_4 & {
|
4620
4549
|
type: 'destroyed';
|
4621
4550
|
};
|
4622
4551
|
|
4552
|
+
/**
|
4553
|
+
* @interface
|
4554
|
+
*/
|
4555
|
+
declare type DeviceInfo = {
|
4556
|
+
vendorId: string | number;
|
4557
|
+
productId: string | number;
|
4558
|
+
};
|
4559
|
+
|
4623
4560
|
/**
|
4624
4561
|
* Generated when a page's theme color changes. This is usually due to encountering a meta tag.
|
4625
4562
|
* @interface
|
@@ -4717,19 +4654,43 @@ declare type DisabledMovementBoundsChangingEvent = BoundsChangeEvent & {
|
|
4717
4654
|
};
|
4718
4655
|
|
4719
4656
|
/**
|
4720
|
-
*
|
4721
|
-
*
|
4722
|
-
* this is their meaning.
|
4657
|
+
* Generated when a Channel client has disconnected.
|
4658
|
+
* @interface
|
4723
4659
|
*/
|
4724
|
-
declare
|
4725
|
-
|
4726
|
-
|
4727
|
-
|
4728
|
-
|
4729
|
-
|
4730
|
-
|
4731
|
-
|
4732
|
-
|
4660
|
+
declare type DisconnectedEvent = BaseEvent_2 & {
|
4661
|
+
type: 'disconnected';
|
4662
|
+
};
|
4663
|
+
|
4664
|
+
/**
|
4665
|
+
* Generated when an external application has disconnected.
|
4666
|
+
* @interface
|
4667
|
+
*/
|
4668
|
+
declare type DisconnectedEvent_2 = BaseExternalApplicationEvent & {
|
4669
|
+
type: 'disconnected';
|
4670
|
+
};
|
4671
|
+
|
4672
|
+
/**
|
4673
|
+
* Generated when a frame has disconnected.
|
4674
|
+
* @interface
|
4675
|
+
*/
|
4676
|
+
declare type DisconnectedEvent_3 = BaseFrameEvent & {
|
4677
|
+
type: 'disconnected';
|
4678
|
+
};
|
4679
|
+
|
4680
|
+
/**
|
4681
|
+
* A system channel will be global enough to have a presence across many apps. This gives us some hints
|
4682
|
+
* to render them in a standard way. It is assumed it may have other properties too, but if it has these,
|
4683
|
+
* this is their meaning.
|
4684
|
+
*/
|
4685
|
+
declare interface DisplayMetadata {
|
4686
|
+
/**
|
4687
|
+
* A user-readable name for this channel, e.g: `"Red"`
|
4688
|
+
*/
|
4689
|
+
readonly name?: string;
|
4690
|
+
/**
|
4691
|
+
* The color that should be associated within this channel when displaying this channel in a UI, e.g: `0xFF0000`.
|
4692
|
+
*/
|
4693
|
+
readonly color?: string;
|
4733
4694
|
/**
|
4734
4695
|
* A URL of an image that can be used to display this channel
|
4735
4696
|
*/
|
@@ -4837,7 +4798,7 @@ declare type DownloadShelfOptions = {
|
|
4837
4798
|
*/
|
4838
4799
|
size?: number;
|
4839
4800
|
/**
|
4840
|
-
* Color of the border
|
4801
|
+
* Color of the border. Must be a 6-character hex code prefixed by #. Defaults to chromium theme
|
4841
4802
|
* if absent.
|
4842
4803
|
*/
|
4843
4804
|
color?: string;
|
@@ -4849,7 +4810,7 @@ declare type DownloadShelfOptions = {
|
|
4849
4810
|
*
|
4850
4811
|
* @interface
|
4851
4812
|
*/
|
4852
|
-
declare type DownloadShelfVisibilityChangedEvent =
|
4813
|
+
declare type DownloadShelfVisibilityChangedEvent = BaseEvent_5 & {
|
4853
4814
|
type: 'download-shelf-visibility-changed';
|
4854
4815
|
/**
|
4855
4816
|
* True if the download shelf was just opened; false if it was just closed.
|
@@ -4879,7 +4840,7 @@ declare interface DragSource {}
|
|
4879
4840
|
* Generated when a window has been embedded.
|
4880
4841
|
* @interface
|
4881
4842
|
*/
|
4882
|
-
declare type EmbeddedEvent =
|
4843
|
+
declare type EmbeddedEvent = BaseEvent_5 & {
|
4883
4844
|
type: 'embedded';
|
4884
4845
|
};
|
4885
4846
|
|
@@ -4983,7 +4944,7 @@ declare class EmitterMap {
|
|
4983
4944
|
* Generated when a window ends loading.
|
4984
4945
|
* @interface
|
4985
4946
|
*/
|
4986
|
-
declare type EndLoadEvent =
|
4947
|
+
declare type EndLoadEvent = BaseEvent_5 & {
|
4987
4948
|
type: 'end-load';
|
4988
4949
|
documentName: string;
|
4989
4950
|
isMain: boolean;
|
@@ -5061,9 +5022,10 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
|
|
5061
5022
|
} : never;
|
5062
5023
|
|
5063
5024
|
declare interface Environment {
|
5064
|
-
|
5025
|
+
initLayoutManager(fin: OpenFin.Fin<OpenFin.EntityType>, wire: Transport, options: OpenFin.InitLayoutOptions): Promise<OpenFin.LayoutManager<OpenFin.LayoutSnapshot>>;
|
5065
5026
|
createLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.CreateLayoutOptions): Promise<void>;
|
5066
5027
|
destroyLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<void>;
|
5028
|
+
resolveLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<any>;
|
5067
5029
|
initPlatform(fin: OpenFin.Fin<OpenFin.EntityType>, ...args: Parameters<OpenFin.Fin['Platform']['init']>): ReturnType<OpenFin.Fin['Platform']['init']>;
|
5068
5030
|
observeBounds(element: Element, onChange: (bounds: DOMRect) => Promise<void> | void): () => void;
|
5069
5031
|
writeToken(path: string, token: string): Promise<string>;
|
@@ -5100,6 +5062,88 @@ declare type ErrorPlainObject = {
|
|
5100
5062
|
toString(): string;
|
5101
5063
|
};
|
5102
5064
|
|
5065
|
+
/**
|
5066
|
+
* [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
|
5067
|
+
* discriminated by {@link Event.type | their type}. Event payloads unique to `Platform` can be found
|
5068
|
+
* under the {@link OpenFin.PlatformEvents} namespace.
|
5069
|
+
*/
|
5070
|
+
declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotAppliedEvent;
|
5071
|
+
|
5072
|
+
/**
|
5073
|
+
* [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
|
5074
|
+
* discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
|
5075
|
+
* under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
5076
|
+
* from which they propagate).
|
5077
|
+
*/
|
5078
|
+
declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
|
5079
|
+
|
5080
|
+
/**
|
5081
|
+
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Channel}. Events are
|
5082
|
+
* discriminated by {@link Event.type | their type}. Event payloads unique to `Channel` can be found
|
5083
|
+
* under the {@link OpenFin.ChannelEvents} namespace.
|
5084
|
+
*/
|
5085
|
+
declare type Event_2 = {
|
5086
|
+
topic: 'channel';
|
5087
|
+
} & (ConnectedEvent | DisconnectedEvent);
|
5088
|
+
|
5089
|
+
/**
|
5090
|
+
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by an {@link Application}. Events are
|
5091
|
+
* discriminated by {@link Event.type | their type}. Event payloads unique to `Application` can be found
|
5092
|
+
* under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
5093
|
+
* from which they propagate).
|
5094
|
+
*/
|
5095
|
+
declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.PropagatedEvent<'application'> | ApplicationWindowEvent | ApplicationSourcedEvent;
|
5096
|
+
|
5097
|
+
/**
|
5098
|
+
* [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
|
5099
|
+
* discriminated by {@link Event.type | their type}. Event payloads unique to `View` can be found
|
5100
|
+
* under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
|
5101
|
+
*/
|
5102
|
+
declare type Event_4 = (WebContentsEvents.Event<'view'> & {
|
5103
|
+
target: OpenFin.Identity;
|
5104
|
+
}) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
|
5105
|
+
|
5106
|
+
/**
|
5107
|
+
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
|
5108
|
+
* (i.e. {@link OpenFin.Window} or {@link OpenFin.View}).
|
5109
|
+
*/
|
5110
|
+
declare type Event_5<Topic extends string> = {
|
5111
|
+
topic: Topic;
|
5112
|
+
} & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent);
|
5113
|
+
|
5114
|
+
/**
|
5115
|
+
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Window}. Events are
|
5116
|
+
* discriminated by {@link Event.type | their type}. Event payloads unique to `Window` can be found
|
5117
|
+
* under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
|
5118
|
+
*/
|
5119
|
+
declare type Event_6 = WindowSourcedEvent | WindowViewEvent | ViewEvents.PropagatedEvent<'window'>;
|
5120
|
+
|
5121
|
+
/**
|
5122
|
+
* [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
|
5123
|
+
* discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
|
5124
|
+
* under the {@link OpenFin.ExternalApplicationEvents} namespace.
|
5125
|
+
*/
|
5126
|
+
declare type Event_7 = ConnectedEvent_3 | DisconnectedEvent_2;
|
5127
|
+
|
5128
|
+
/**
|
5129
|
+
* [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
|
5130
|
+
* discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
|
5131
|
+
* under the {@link OpenFin.FrameEvents} namespace.
|
5132
|
+
*/
|
5133
|
+
declare type Event_8 = {
|
5134
|
+
topic: 'frame';
|
5135
|
+
} & (ConnectedEvent_4 | DisconnectedEvent_3);
|
5136
|
+
|
5137
|
+
/**
|
5138
|
+
* [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
|
5139
|
+
* discriminated by {@link Event.type | their type}. Event payloads unique to `GlobalHotkey` can be found
|
5140
|
+
* under the {@link OpenFin.GlobalHotkeyEvents} namespace.
|
5141
|
+
*/
|
5142
|
+
declare type Event_9 = {
|
5143
|
+
topic: 'global-hotkey';
|
5144
|
+
hotkey: 'string';
|
5145
|
+
} & (RegisteredEvent | UnregisteredEvent);
|
5146
|
+
|
5103
5147
|
declare class EventAggregator extends EmitterMap {
|
5104
5148
|
dispatchEvent: (message: Message<any>) => boolean;
|
5105
5149
|
}
|
@@ -5165,6 +5209,46 @@ declare namespace Events {
|
|
5165
5209
|
}
|
5166
5210
|
}
|
5167
5211
|
|
5212
|
+
/**
|
5213
|
+
* Union of possible `type` values for a view {@link Event}.
|
5214
|
+
*/
|
5215
|
+
declare type EventType = Event_4['type'];
|
5216
|
+
|
5217
|
+
/**
|
5218
|
+
* Union of possible `type` values for a Window {@link Event}.
|
5219
|
+
*/
|
5220
|
+
declare type EventType_2 = Event_6['type'];
|
5221
|
+
|
5222
|
+
/**
|
5223
|
+
* Union of possible `type` values for an Application {@link Event}.
|
5224
|
+
*/
|
5225
|
+
declare type EventType_3 = Event_3['type'];
|
5226
|
+
|
5227
|
+
/**
|
5228
|
+
* Union of possible `type` values for an ExternalApplication {@link Event}.
|
5229
|
+
*/
|
5230
|
+
declare type EventType_4 = Event_7['type'];
|
5231
|
+
|
5232
|
+
/**
|
5233
|
+
* Union of possible `type` values for a {@link FrameEvent}.
|
5234
|
+
*/
|
5235
|
+
declare type EventType_5 = Event_8['type'];
|
5236
|
+
|
5237
|
+
/**
|
5238
|
+
* Union of possible `type` values for a {@link GlobalHotkeyEvent}
|
5239
|
+
*/
|
5240
|
+
declare type EventType_6 = Event_9['type'];
|
5241
|
+
|
5242
|
+
/**
|
5243
|
+
* Union of possible `type` values for a {@link PlatformEvent}.
|
5244
|
+
*/
|
5245
|
+
declare type EventType_7 = Event_10['type'];
|
5246
|
+
|
5247
|
+
/**
|
5248
|
+
* Union of possible `type` values for a {@link SystemEvent}.
|
5249
|
+
*/
|
5250
|
+
declare type EventType_8 = Event_11['type'];
|
5251
|
+
|
5168
5252
|
/**
|
5169
5253
|
* @internal
|
5170
5254
|
*/
|
@@ -5178,6 +5262,8 @@ declare type EventWithId<Event extends AppVersionEvent> = Event extends infer E
|
|
5178
5262
|
|
5179
5263
|
/**
|
5180
5264
|
* @internal
|
5265
|
+
*
|
5266
|
+
* Ensures that an event payload type does not include any `-requested` events. Distributes over unions.
|
5181
5267
|
*/
|
5182
5268
|
declare type ExcludeRequested<Event extends {
|
5183
5269
|
type: string;
|
@@ -5214,83 +5300,6 @@ declare class ExternalApplication extends EmitterBase<OpenFin.ExternalApplicatio
|
|
5214
5300
|
* @internal
|
5215
5301
|
*/
|
5216
5302
|
constructor(wire: Transport, identity: OpenFin.ApplicationIdentity);
|
5217
|
-
/**
|
5218
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
5219
|
-
* @param eventType - The type of the event.
|
5220
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
5221
|
-
* @param options - Option to support event timestamps.
|
5222
|
-
*
|
5223
|
-
* @function addListener
|
5224
|
-
* @memberof ExternalApplication
|
5225
|
-
* @instance
|
5226
|
-
* @tutorial ExternalApplication.EventEmitter
|
5227
|
-
*/
|
5228
|
-
/**
|
5229
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
5230
|
-
* @param eventType - The type of the event.
|
5231
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
5232
|
-
* @param options - Option to support event timestamps.
|
5233
|
-
*
|
5234
|
-
* @function on
|
5235
|
-
* @memberof ExternalApplication
|
5236
|
-
* @instance
|
5237
|
-
* @tutorial ExternalApplication.EventEmitter
|
5238
|
-
*/
|
5239
|
-
/**
|
5240
|
-
* 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.
|
5241
|
-
* @param eventType - The type of the event.
|
5242
|
-
* @param listener - The callback function.
|
5243
|
-
* @param options - Option to support event timestamps.
|
5244
|
-
*
|
5245
|
-
* @function once
|
5246
|
-
* @memberof ExternalApplication
|
5247
|
-
* @instance
|
5248
|
-
* @tutorial ExternalApplication.EventEmitter
|
5249
|
-
*/
|
5250
|
-
/**
|
5251
|
-
* Adds a listener to the beginning of the listeners array for the specified event.
|
5252
|
-
* @param eventType - The type of the event.
|
5253
|
-
* @param listener - The callback function.
|
5254
|
-
* @param options - Option to support event timestamps.
|
5255
|
-
*
|
5256
|
-
* @function prependListener
|
5257
|
-
* @memberof ExternalApplication
|
5258
|
-
* @instance
|
5259
|
-
* @tutorial ExternalApplication.EventEmitter
|
5260
|
-
*/
|
5261
|
-
/**
|
5262
|
-
* 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.
|
5263
|
-
* The listener is added to the beginning of the listeners array.
|
5264
|
-
* @param eventType - The type of the event.
|
5265
|
-
* @param listener - The callback function.
|
5266
|
-
* @param options - Option to support event timestamps.
|
5267
|
-
*
|
5268
|
-
* @function prependOnceListener
|
5269
|
-
* @memberof ExternalApplication
|
5270
|
-
* @instance
|
5271
|
-
* @tutorial ExternalApplication.EventEmitter
|
5272
|
-
*/
|
5273
|
-
/**
|
5274
|
-
* Remove a listener from the listener array for the specified event.
|
5275
|
-
* Caution: Calling this method changes the array indices in the listener array behind the listener.
|
5276
|
-
* @param eventType - The type of the event.
|
5277
|
-
* @param listener - The callback function.
|
5278
|
-
* @param options - Option to support event timestamps.
|
5279
|
-
*
|
5280
|
-
* @function removeListener
|
5281
|
-
* @memberof ExternalApplication
|
5282
|
-
* @instance
|
5283
|
-
* @tutorial ExternalApplication.EventEmitter
|
5284
|
-
*/
|
5285
|
-
/**
|
5286
|
-
* Removes all listeners, or those of the specified event.
|
5287
|
-
* @param eventType - The type of the event.
|
5288
|
-
*
|
5289
|
-
* @function removeAllListeners
|
5290
|
-
* @memberof ExternalApplication
|
5291
|
-
* @instance
|
5292
|
-
* @tutorial ExternalApplication.EventEmitter
|
5293
|
-
*/
|
5294
5303
|
/**
|
5295
5304
|
* Retrieves information about the external application.
|
5296
5305
|
*
|
@@ -5307,46 +5316,43 @@ declare class ExternalApplication extends EmitterBase<OpenFin.ExternalApplicatio
|
|
5307
5316
|
}
|
5308
5317
|
|
5309
5318
|
/**
|
5310
|
-
*
|
5311
|
-
* @interface
|
5319
|
+
* @deprecated Renamed to {@link ConnectedEvent}.
|
5312
5320
|
*/
|
5313
|
-
declare type ExternalApplicationConnectedEvent =
|
5314
|
-
type: 'connected';
|
5315
|
-
};
|
5321
|
+
declare type ExternalApplicationConnectedEvent = ConnectedEvent_3;
|
5316
5322
|
|
5317
5323
|
/**
|
5318
|
-
*
|
5319
|
-
* @interface
|
5324
|
+
* @deprecated Renamed to {@link DisconnectedEvent}.
|
5320
5325
|
*/
|
5321
|
-
declare type ExternalApplicationDisconnectedEvent =
|
5322
|
-
type: 'disconnected';
|
5323
|
-
};
|
5326
|
+
declare type ExternalApplicationDisconnectedEvent = DisconnectedEvent_2;
|
5324
5327
|
|
5325
5328
|
/**
|
5326
|
-
*
|
5327
|
-
* discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
|
5328
|
-
* under the {@link OpenFin.ExternalApplicationEvents} namespace.
|
5329
|
+
* @deprecated Renamed to {@link Event}.
|
5329
5330
|
*/
|
5330
|
-
declare type ExternalApplicationEvent =
|
5331
|
+
declare type ExternalApplicationEvent = Event_7;
|
5331
5332
|
|
5332
5333
|
declare type ExternalApplicationEvent_2 = Events.ExternalApplicationEvents.ExternalApplicationEvent;
|
5333
5334
|
|
5334
5335
|
declare namespace ExternalApplicationEvents {
|
5335
5336
|
export {
|
5337
|
+
BaseEvent_6 as BaseEvent,
|
5336
5338
|
BaseExternalApplicationEvent,
|
5339
|
+
ConnectedEvent_3 as ConnectedEvent,
|
5337
5340
|
ExternalApplicationConnectedEvent,
|
5341
|
+
DisconnectedEvent_2 as DisconnectedEvent,
|
5338
5342
|
ExternalApplicationDisconnectedEvent,
|
5343
|
+
Event_7 as Event,
|
5339
5344
|
ExternalApplicationEvent,
|
5345
|
+
EventType_4 as EventType,
|
5340
5346
|
ExternalApplicationEventType,
|
5341
|
-
|
5342
|
-
|
5347
|
+
Payload_5 as Payload,
|
5348
|
+
ByType_4 as ByType
|
5343
5349
|
}
|
5344
5350
|
}
|
5345
5351
|
|
5346
5352
|
/**
|
5347
|
-
*
|
5353
|
+
* @deprecated Renamed to {@link Event}.
|
5348
5354
|
*/
|
5349
|
-
declare type ExternalApplicationEventType =
|
5355
|
+
declare type ExternalApplicationEventType = EventType_4;
|
5350
5356
|
|
5351
5357
|
/**
|
5352
5358
|
* @interface
|
@@ -5411,7 +5417,7 @@ declare type ExternalConnection = {
|
|
5411
5417
|
* Generated when an external process has exited.
|
5412
5418
|
* @interface
|
5413
5419
|
*/
|
5414
|
-
declare type ExternalProcessExitedEvent =
|
5420
|
+
declare type ExternalProcessExitedEvent = BaseEvent_5 & {
|
5415
5421
|
type: 'external-process-exited';
|
5416
5422
|
processUuid: string;
|
5417
5423
|
exitCode: number;
|
@@ -5456,19 +5462,15 @@ declare type ExternalProcessRequestType = {
|
|
5456
5462
|
* Generated when an external process has started.
|
5457
5463
|
* @interface
|
5458
5464
|
*/
|
5459
|
-
declare type ExternalProcessStartedEvent =
|
5465
|
+
declare type ExternalProcessStartedEvent = BaseEvent_5 & {
|
5460
5466
|
type: 'external-process-started';
|
5461
5467
|
processUuid: string;
|
5462
5468
|
};
|
5463
5469
|
|
5464
5470
|
/**
|
5465
|
-
*
|
5466
|
-
* @interface
|
5471
|
+
* @deprecated, use {@link PageFaviconUpdatedEvent}.
|
5467
5472
|
*/
|
5468
|
-
declare type FaviconUpdatedEvent =
|
5469
|
-
type: 'page-favicon-updated';
|
5470
|
-
favicons: string[];
|
5471
|
-
};
|
5473
|
+
declare type FaviconUpdatedEvent = PageFaviconUpdatedEvent;
|
5472
5474
|
|
5473
5475
|
declare namespace FDC3 {
|
5474
5476
|
export {
|
@@ -5555,7 +5557,7 @@ declare type FileDownloadEvent = {
|
|
5555
5557
|
*
|
5556
5558
|
* @interface
|
5557
5559
|
*/
|
5558
|
-
declare type FileDownloadLocationChangedEvent =
|
5560
|
+
declare type FileDownloadLocationChangedEvent = BaseEvent_3 & {
|
5559
5561
|
type: 'file-download-location-changed';
|
5560
5562
|
};
|
5561
5563
|
|
@@ -5742,83 +5744,6 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
|
|
5742
5744
|
* @internal
|
5743
5745
|
*/
|
5744
5746
|
constructor(wire: Transport, identity: OpenFin.Identity);
|
5745
|
-
/**
|
5746
|
-
* Adds the listener function to the end of the listeners array for the specified event type.
|
5747
|
-
* @param eventType - The type of the event.
|
5748
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
5749
|
-
* @param options - Option to support event timestamps.
|
5750
|
-
*
|
5751
|
-
* @function addListener
|
5752
|
-
* @memberof Frame
|
5753
|
-
* @instance
|
5754
|
-
* @tutorial Frame.EventEmitter
|
5755
|
-
*/
|
5756
|
-
/**
|
5757
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
5758
|
-
* @param eventType - The type of the event.
|
5759
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
5760
|
-
* @param options - Option to support event timestamps.
|
5761
|
-
*
|
5762
|
-
* @function on
|
5763
|
-
* @memberof Frame
|
5764
|
-
* @instance
|
5765
|
-
* @tutorial Frame.EventEmitter
|
5766
|
-
*/
|
5767
|
-
/**
|
5768
|
-
* 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.
|
5769
|
-
* @param eventType - The type of the event.
|
5770
|
-
* @param listener - The callback function.
|
5771
|
-
* @param options - Option to support event timestamps.
|
5772
|
-
*
|
5773
|
-
* @function once
|
5774
|
-
* @memberof Frame
|
5775
|
-
* @instance
|
5776
|
-
* @tutorial Frame.EventEmitter
|
5777
|
-
*/
|
5778
|
-
/**
|
5779
|
-
* Adds a listener to the beginning of the listeners array for the specified event.
|
5780
|
-
* @param eventType - The type of the event.
|
5781
|
-
* @param listener - The callback function.
|
5782
|
-
* @param options - Option to support event timestamps.
|
5783
|
-
*
|
5784
|
-
* @function prependListener
|
5785
|
-
* @memberof Frame
|
5786
|
-
* @instance
|
5787
|
-
* @tutorial Frame.EventEmitter
|
5788
|
-
*/
|
5789
|
-
/**
|
5790
|
-
* 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.
|
5791
|
-
* The listener is added to the beginning of the listeners array.
|
5792
|
-
* @param eventType - The type of the event.
|
5793
|
-
* @param listener - The callback function.
|
5794
|
-
* @param options - Option to support event timestamps.
|
5795
|
-
*
|
5796
|
-
* @function prependOnceListener
|
5797
|
-
* @memberof Frame
|
5798
|
-
* @instance
|
5799
|
-
* @tutorial Frame.EventEmitter
|
5800
|
-
*/
|
5801
|
-
/**
|
5802
|
-
* Remove a listener from the listener array for the specified event.
|
5803
|
-
* Caution: Calling this method changes the array indices in the listener array behind the listener.
|
5804
|
-
* @param eventType - The type of the event.
|
5805
|
-
* @param listener - The callback function.
|
5806
|
-
* @param options - Option to support event timestamps.
|
5807
|
-
*
|
5808
|
-
* @function removeListener
|
5809
|
-
* @memberof Frame
|
5810
|
-
* @instance
|
5811
|
-
* @tutorial Frame.EventEmitter
|
5812
|
-
*/
|
5813
|
-
/**
|
5814
|
-
* Removes all listeners, or those of the specified event.
|
5815
|
-
* @param eventType - The type of the event.
|
5816
|
-
*
|
5817
|
-
* @function removeAllListeners
|
5818
|
-
* @memberof Frame
|
5819
|
-
* @instance
|
5820
|
-
* @tutorial Frame.EventEmitter
|
5821
|
-
*/
|
5822
5747
|
/**
|
5823
5748
|
* Returns a frame info object for the represented frame.
|
5824
5749
|
*
|
@@ -5849,48 +5774,43 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
|
|
5849
5774
|
}
|
5850
5775
|
|
5851
5776
|
/**
|
5852
|
-
*
|
5853
|
-
* @interface
|
5777
|
+
* @deprecated Renamed to {@link ConnectedEvent}.
|
5854
5778
|
*/
|
5855
|
-
declare type FrameConnectedEvent =
|
5856
|
-
type: 'connected';
|
5857
|
-
};
|
5779
|
+
declare type FrameConnectedEvent = ConnectedEvent_4;
|
5858
5780
|
|
5859
5781
|
/**
|
5860
|
-
*
|
5861
|
-
* @interface
|
5782
|
+
* @deprecated Renamed to {@link DisconnectedEvent}.
|
5862
5783
|
*/
|
5863
|
-
declare type FrameDisconnectedEvent =
|
5864
|
-
type: 'disconnected';
|
5865
|
-
};
|
5784
|
+
declare type FrameDisconnectedEvent = DisconnectedEvent_3;
|
5866
5785
|
|
5867
5786
|
/**
|
5868
|
-
*
|
5869
|
-
* discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
|
5870
|
-
* under the {@link OpenFin.FrameEvents} namespace.
|
5787
|
+
* @deprecated Renamed to {@link Event}.
|
5871
5788
|
*/
|
5872
|
-
declare type FrameEvent =
|
5873
|
-
topic: 'frame';
|
5874
|
-
} & (FrameConnectedEvent | FrameDisconnectedEvent);
|
5789
|
+
declare type FrameEvent = Event_8;
|
5875
5790
|
|
5876
5791
|
declare type FrameEvent_2 = Events.FrameEvents.FrameEvent;
|
5877
5792
|
|
5878
5793
|
declare namespace FrameEvents {
|
5879
5794
|
export {
|
5795
|
+
BaseEvent_7 as BaseEvent,
|
5880
5796
|
BaseFrameEvent,
|
5797
|
+
ConnectedEvent_4 as ConnectedEvent,
|
5881
5798
|
FrameConnectedEvent,
|
5799
|
+
DisconnectedEvent_3 as DisconnectedEvent,
|
5882
5800
|
FrameDisconnectedEvent,
|
5801
|
+
Event_8 as Event,
|
5883
5802
|
FrameEvent,
|
5803
|
+
EventType_5 as EventType,
|
5884
5804
|
FrameEventType,
|
5885
|
-
|
5886
|
-
|
5805
|
+
Payload_6 as Payload,
|
5806
|
+
ByType_5 as ByType
|
5887
5807
|
}
|
5888
5808
|
}
|
5889
5809
|
|
5890
5810
|
/**
|
5891
|
-
*
|
5811
|
+
* @deprecated Renamed to {@link EventType}.
|
5892
5812
|
*/
|
5893
|
-
declare type FrameEventType =
|
5813
|
+
declare type FrameEventType = EventType_5;
|
5894
5814
|
|
5895
5815
|
/**
|
5896
5816
|
* @interface
|
@@ -6112,14 +6032,9 @@ declare class GlobalHotkey extends EmitterBase<OpenFin.GlobalHotkeyEvent> {
|
|
6112
6032
|
}
|
6113
6033
|
|
6114
6034
|
/**
|
6115
|
-
*
|
6116
|
-
* discriminated by {@link GlobalHotkeyEvent.type | their type}. Event payloads unique to `GlobalHotkey` can be found
|
6117
|
-
* under the {@link OpenFin.GlobalHotkeyEvents} namespace.
|
6035
|
+
* @deprecated Renamed to {@link Event}.
|
6118
6036
|
*/
|
6119
|
-
declare type GlobalHotkeyEvent =
|
6120
|
-
topic: 'global-hotkey';
|
6121
|
-
hotkey: 'string';
|
6122
|
-
} & (RegisteredEvent | UnregisteredEvent);
|
6037
|
+
declare type GlobalHotkeyEvent = Event_9;
|
6123
6038
|
|
6124
6039
|
declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
|
6125
6040
|
|
@@ -6127,17 +6042,19 @@ declare namespace GlobalHotkeyEvents {
|
|
6127
6042
|
export {
|
6128
6043
|
RegisteredEvent,
|
6129
6044
|
UnregisteredEvent,
|
6045
|
+
Event_9 as Event,
|
6130
6046
|
GlobalHotkeyEvent,
|
6047
|
+
EventType_6 as EventType,
|
6131
6048
|
GlobalHotkeyEventType,
|
6132
|
-
|
6133
|
-
|
6049
|
+
Payload_7 as Payload,
|
6050
|
+
ByType_6 as ByType
|
6134
6051
|
}
|
6135
6052
|
}
|
6136
6053
|
|
6137
6054
|
/**
|
6138
|
-
*
|
6055
|
+
* @deprecated Renamed to {@link EventType}.
|
6139
6056
|
*/
|
6140
|
-
declare type GlobalHotkeyEventType =
|
6057
|
+
declare type GlobalHotkeyEventType = EventType_6;
|
6141
6058
|
|
6142
6059
|
declare namespace GoldenLayout {
|
6143
6060
|
export {
|
@@ -6439,8 +6356,17 @@ declare interface Header {
|
|
6439
6356
|
* Generated when a View is hidden.
|
6440
6357
|
* @interface
|
6441
6358
|
*/
|
6442
|
-
declare type HiddenEvent =
|
6359
|
+
declare type HiddenEvent = BaseEvent_4 & {
|
6360
|
+
type: 'hidden';
|
6361
|
+
};
|
6362
|
+
|
6363
|
+
/**
|
6364
|
+
* Generated when a window has been hidden.
|
6365
|
+
* @interface
|
6366
|
+
*/
|
6367
|
+
declare type HiddenEvent_2 = BaseEvent_5 & {
|
6443
6368
|
type: 'hidden';
|
6369
|
+
reason: 'closing' | 'hide' | 'hide-on-close';
|
6444
6370
|
};
|
6445
6371
|
|
6446
6372
|
/**
|
@@ -6448,7 +6374,7 @@ declare type HiddenEvent = BaseViewEvent & {
|
|
6448
6374
|
* or because the View has moved to a new window. Only available on Views in a Platform.
|
6449
6375
|
* @interface
|
6450
6376
|
*/
|
6451
|
-
declare type HostContextChangedEvent =
|
6377
|
+
declare type HostContextChangedEvent = BaseEvent_4 & {
|
6452
6378
|
type: 'host-context-changed';
|
6453
6379
|
context: any;
|
6454
6380
|
reason: 'reparented' | 'updated';
|
@@ -6527,7 +6453,16 @@ declare type Hotkey = {
|
|
6527
6453
|
* @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
|
6528
6454
|
* @interface
|
6529
6455
|
*/
|
6530
|
-
declare type HotkeyEvent =
|
6456
|
+
declare type HotkeyEvent = BaseEvent_4 & {
|
6457
|
+
type: 'hotkey';
|
6458
|
+
};
|
6459
|
+
|
6460
|
+
/**
|
6461
|
+
* Generated when a keyboard shortcut defined in the `hotkeys` array in [Window options](OpenFin.WindowOptions.html) is pressed inside the window.
|
6462
|
+
* @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
|
6463
|
+
* @interface
|
6464
|
+
*/
|
6465
|
+
declare type HotkeyEvent_2 = InputEvent_2 & BaseEvent_5 & {
|
6531
6466
|
type: 'hotkey';
|
6532
6467
|
};
|
6533
6468
|
|
@@ -6583,6 +6518,11 @@ declare type IdentityEvent = BaseEvent & {
|
|
6583
6518
|
*/
|
6584
6519
|
declare type IdEventType = WithId<AppVersionEventType>;
|
6585
6520
|
|
6521
|
+
/**
|
6522
|
+
* @deprecated Renamed to {@link IdleStateChangedEvent}.
|
6523
|
+
*/
|
6524
|
+
declare type IdleEvent = IdleStateChangedEvent;
|
6525
|
+
|
6586
6526
|
/**
|
6587
6527
|
* Generated when a user enters or returns from idle state.
|
6588
6528
|
* @remarks This method is continuously generated every minute while the user is in idle.
|
@@ -6590,7 +6530,7 @@ declare type IdEventType = WithId<AppVersionEventType>;
|
|
6590
6530
|
* A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
|
6591
6531
|
* @interface
|
6592
6532
|
*/
|
6593
|
-
declare type
|
6533
|
+
declare type IdleStateChangedEvent = BaseEvent_8 & {
|
6594
6534
|
type: 'idle-state-changed';
|
6595
6535
|
elapsedTime: number;
|
6596
6536
|
isIdle: boolean;
|
@@ -6675,11 +6615,19 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
|
|
6675
6615
|
* Generated when an application has initialized.
|
6676
6616
|
* @interface
|
6677
6617
|
*/
|
6678
|
-
declare type InitializedEvent = IdentityEvent & {
|
6618
|
+
declare type InitializedEvent = BaseEvents.IdentityEvent & {
|
6679
6619
|
topic: 'application';
|
6680
6620
|
type: 'initialized';
|
6681
6621
|
};
|
6682
6622
|
|
6623
|
+
/**
|
6624
|
+
* Generated when a window is initialized.
|
6625
|
+
* @interface
|
6626
|
+
*/
|
6627
|
+
declare type InitializedEvent_2 = BaseEvent_5 & {
|
6628
|
+
type: 'initialized';
|
6629
|
+
};
|
6630
|
+
|
6683
6631
|
/**
|
6684
6632
|
* @interface
|
6685
6633
|
*/
|
@@ -7080,64 +7028,14 @@ declare class InteropBroker extends Base {
|
|
7080
7028
|
new (): InteropBroker;
|
7081
7029
|
};
|
7082
7030
|
/**
|
7083
|
-
*
|
7084
|
-
*
|
7085
|
-
* @
|
7086
|
-
*
|
7087
|
-
*/
|
7088
|
-
/**
|
7089
|
-
* @REMOVED
|
7090
|
-
* GetContextOptions interface
|
7091
|
-
* @typedef { object } GetContextOptions@typedef { object } GetContextOptions
|
7092
|
-
* @property { string } [contextType] - Context Type
|
7093
|
-
*/
|
7094
|
-
/**
|
7095
|
-
* @REMOVED
|
7096
|
-
* JoinContextGroupOptions interface
|
7097
|
-
* @typedef { object } JoinContextGroupOptions@typedef { object } JoinContextGroupOptions
|
7098
|
-
* @property { string } contextGroupId - Id of the context group.
|
7099
|
-
* @property { Identity | ClientIdentity } [target] - Identity of the entity you wish to join to a context group.
|
7031
|
+
* Sets a context for the context group of the incoming current entity.
|
7032
|
+
* @param setContextOptions - New context to set.
|
7033
|
+
* @param clientIdentity - Identity of the client sender.
|
7034
|
+
*
|
7100
7035
|
*/
|
7101
|
-
|
7102
|
-
|
7103
|
-
|
7104
|
-
* @typedef { object } AddClientToContextGroupOptions@typedef { object } AddClientToContextGroupOptions
|
7105
|
-
* @property { string } contextGroupId - Name of the context group.
|
7106
|
-
*/
|
7107
|
-
/**
|
7108
|
-
* @REMOVED
|
7109
|
-
* RemoveFromContextGroupOptions interface
|
7110
|
-
* @typedef { object } RemoveFromContextGroupOptions@typedef { object } RemoveFromContextGroupOptions
|
7111
|
-
* @property { Identity | ClientIdentity } target - Identity of the entity you wish to join to a context group.
|
7112
|
-
*/
|
7113
|
-
/**
|
7114
|
-
* @REMOVED
|
7115
|
-
* GetInfoForContextGroupOptions interface
|
7116
|
-
* @typedef { object } GetInfoForContextGroupOptions@typedef { object } GetInfoForContextGroupOptions
|
7117
|
-
* @property { string } contextGroupId - Name of the context group to get info for.
|
7118
|
-
*/
|
7119
|
-
/**
|
7120
|
-
* @REMOVED
|
7121
|
-
* GetAllClientsInContextGroupOptions interface
|
7122
|
-
* @typedef { object } GetAllClientsInContextGroupOptions@typedef { object } GetAllClientsInContextGroupOptions
|
7123
|
-
* @property { string } contextGroupId - Name of the context group to get info for.
|
7124
|
-
*/
|
7125
|
-
/**
|
7126
|
-
* @PORTED
|
7127
|
-
* InfoForIntentOptions interface
|
7128
|
-
* @typedef { object } InfoForIntentOptions@typedef { object } InfoForIntentOptions
|
7129
|
-
* @property { string } name Name of the intent to get info for.
|
7130
|
-
* @property { Context } [context] Optional context.
|
7131
|
-
*/
|
7132
|
-
/**
|
7133
|
-
* Sets a context for the context group of the incoming current entity.
|
7134
|
-
* @param setContextOptions - New context to set.
|
7135
|
-
* @param clientIdentity - Identity of the client sender.
|
7136
|
-
*
|
7137
|
-
*/
|
7138
|
-
setContext({ context }: {
|
7139
|
-
context: OpenFin.Context;
|
7140
|
-
}, clientIdentity: OpenFin.ClientIdentity): void;
|
7036
|
+
setContext({ context }: {
|
7037
|
+
context: OpenFin.Context;
|
7038
|
+
}, clientIdentity: OpenFin.ClientIdentity): void;
|
7141
7039
|
/**
|
7142
7040
|
* Get current context for a client subscribed to a Context Group.
|
7143
7041
|
*
|
@@ -7372,7 +7270,7 @@ declare class InteropBroker extends Base {
|
|
7372
7270
|
* // }
|
7373
7271
|
* ```
|
7374
7272
|
*
|
7375
|
-
* More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/
|
7273
|
+
* More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/Metadata#intentresolution).
|
7376
7274
|
*
|
7377
7275
|
* @param contextForIntent Data passed between entities and applications.
|
7378
7276
|
* @param clientIdentity Identity of the Client making the request.
|
@@ -7628,95 +7526,6 @@ declare type InteropBrokerOptions = {
|
|
7628
7526
|
logging?: InteropLoggingOptions;
|
7629
7527
|
};
|
7630
7528
|
|
7631
|
-
/**
|
7632
|
-
* @PORTED
|
7633
|
-
* @typedef { object } Intent
|
7634
|
-
* @summary The combination of an action and a context that is passed to an application for resolution.
|
7635
|
-
* @property { string } name Name of the intent.
|
7636
|
-
* @property { Context } context Data associated with the intent
|
7637
|
-
*/
|
7638
|
-
/**
|
7639
|
-
* @REMOVED
|
7640
|
-
* @typedef { object } Subscription
|
7641
|
-
* @summary Object returned when subscribing a handler.
|
7642
|
-
* @property { function } unsubscribe Function to unsubscribe the handler.
|
7643
|
-
*/
|
7644
|
-
/**
|
7645
|
-
* @typedef { function } ContextHandler
|
7646
|
-
* @summary Subscription function for addContextHandler.
|
7647
|
-
*/
|
7648
|
-
/**
|
7649
|
-
* @typedef { function } IntentHandler
|
7650
|
-
* @summary Subscription function for registerIntentHandler
|
7651
|
-
*/
|
7652
|
-
/**
|
7653
|
-
* @PORTED
|
7654
|
-
* @typedef { object } ClientIdentity
|
7655
|
-
* @summary The Identity for a Channel Client. Includes endpointId to differentiate between different connections for an entity.
|
7656
|
-
* @property {string} uuid GUID of an application.
|
7657
|
-
* @property {string} name Name of an entity in an application.
|
7658
|
-
* @property {string} endpointId Unique differentiator for different Channel connections for an entity.
|
7659
|
-
*/
|
7660
|
-
/**
|
7661
|
-
* @PORTED
|
7662
|
-
* @typedef { object } ContextGroupInfo
|
7663
|
-
* @summary Information for a Context Group. Contains metadata for displaying the group properly.
|
7664
|
-
* @property {string} id Name of the context group
|
7665
|
-
* @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.
|
7666
|
-
*/
|
7667
|
-
/**
|
7668
|
-
* @PORTED
|
7669
|
-
* @typedef { object } DisplayMetadata
|
7670
|
-
* @summary The display data for a Context Group.
|
7671
|
-
* @property {string} name A user-readable name for this context group, e.g: `"Red"`
|
7672
|
-
* @property {string} [color] The color that should be associated within this context group when displaying this context group in a UI, e.g: `0xFF0000`.
|
7673
|
-
* @property {string} [glyph] A URL of an image that can be used to display this context group
|
7674
|
-
*/
|
7675
|
-
/**
|
7676
|
-
* @PORTED
|
7677
|
-
* @typedef { object } Context
|
7678
|
-
* @summary Data passed between entities and applications.
|
7679
|
-
* @property {object} [id] An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
|
7680
|
-
* @property {string} [name] User-readable name for the incoming context.
|
7681
|
-
* @property {string} type Conserved type for the context (e.g. `instrument` or `country`)
|
7682
|
-
*/
|
7683
|
-
/**
|
7684
|
-
* @REMOVED
|
7685
|
-
* @typedef { object } ContextForIntent
|
7686
|
-
* @summary Data passed between entities and applications, including an optional metadata.
|
7687
|
-
* @property {object} [id] An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
|
7688
|
-
* @property {string} [name] User-readable name for the incoming context.
|
7689
|
-
* @property {string} type Conserved type for the context (e.g. `instrument` or `country`)
|
7690
|
-
* @property {any} [metadata]
|
7691
|
-
*/
|
7692
|
-
/**
|
7693
|
-
* @REMOVED
|
7694
|
-
* @typedef { object } SessionContextGroup
|
7695
|
-
* @summary An instance of a SessionContextGroup
|
7696
|
-
* @property {string} id The SessionContextGroup's id.
|
7697
|
-
* @property {setContext} setContext Sets a context of a certain type
|
7698
|
-
* @property {getCurrentContext} getCurrentContext Gets the currently set context of a certain type
|
7699
|
-
* @property {addContextHandler} addContextHandler Adds a handler for context change.
|
7700
|
-
*/
|
7701
|
-
/**
|
7702
|
-
* @typedef {function} setContext
|
7703
|
-
* @summary A SessionContextGroup instance method for setting a context in the SessionContextGroup.
|
7704
|
-
* @param context The Context to be set.
|
7705
|
-
*
|
7706
|
-
*/
|
7707
|
-
/**
|
7708
|
-
* @typedef {function} getCurrentContext
|
7709
|
-
* @summary A SessionContextGroup instance method for getting the current context of a certain type.
|
7710
|
-
* @param contextType The Context Type to get. If not specified the last contextType set would get used.
|
7711
|
-
*
|
7712
|
-
*/
|
7713
|
-
/**
|
7714
|
-
* @typedef {function} addContextHandler
|
7715
|
-
* @summary A SessionContextGroup instance method for adding a handler for context change.
|
7716
|
-
* @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.
|
7717
|
-
* @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.
|
7718
|
-
*
|
7719
|
-
*/
|
7720
7529
|
/**
|
7721
7530
|
* {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}
|
7722
7531
|
*
|
@@ -8155,13 +7964,6 @@ declare type InteropLoggingActions = 'beforeAction' | 'afterAction';
|
|
8155
7964
|
*/
|
8156
7965
|
declare type InteropLoggingOptions = Record<InteropLoggingActions, InteropActionLoggingOption>;
|
8157
7966
|
|
8158
|
-
/**
|
8159
|
-
* @PORTED
|
8160
|
-
* @typedef { object } InteropConfig
|
8161
|
-
* @summary Information relevant to the Interop Broker.
|
8162
|
-
* @property {string} [currentContextGroup] Context Group for the client. (green, yellow, red, etc.)
|
8163
|
-
* @property {string} [providerId] When provided, automatically connects the client to the specified provider uuid
|
8164
|
-
*/
|
8165
7967
|
/**
|
8166
7968
|
* Manages creation of Interop Brokers and Interop Clients. These APIs are called under-the-hood in Platforms.
|
8167
7969
|
*
|
@@ -8554,7 +8356,7 @@ declare class Layout extends Base {
|
|
8554
8356
|
* @internal
|
8555
8357
|
*/
|
8556
8358
|
init: (options?: OpenFin.InitLayoutOptions) => Promise<Layout>;
|
8557
|
-
identity: OpenFin.LayoutIdentity;
|
8359
|
+
identity: OpenFin.Identity | OpenFin.LayoutIdentity;
|
8558
8360
|
private platform;
|
8559
8361
|
wire: Transport;
|
8560
8362
|
/**
|
@@ -8773,45 +8575,24 @@ declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'r
|
|
8773
8575
|
*/
|
8774
8576
|
declare type LayoutIdentity = Identity_5 & {
|
8775
8577
|
/**
|
8776
|
-
* The name of the layout
|
8777
|
-
* OpenFin attempts to resolve the instance via visibility checks.
|
8578
|
+
* The name of the layout in a given window.
|
8778
8579
|
*/
|
8779
|
-
layoutName
|
8580
|
+
layoutName: string;
|
8780
8581
|
};
|
8781
8582
|
|
8782
8583
|
/**
|
8783
|
-
* Generated when
|
8584
|
+
* Generated when the window is created, and all of its layout's views have either finished or failed
|
8585
|
+
* navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
|
8784
8586
|
* @interface
|
8785
8587
|
*/
|
8786
|
-
declare type LayoutInitializedEvent =
|
8588
|
+
declare type LayoutInitializedEvent = BaseEvent_5 & {
|
8787
8589
|
type: 'layout-initialized';
|
8590
|
+
layoutIdentity: OpenFin.LayoutIdentity;
|
8788
8591
|
ofViews: (OpenFin.Identity & {
|
8789
8592
|
entityType: 'view';
|
8790
8593
|
})[];
|
8791
8594
|
};
|
8792
8595
|
|
8793
|
-
/**
|
8794
|
-
* @interface @experimental @internal
|
8795
|
-
*
|
8796
|
-
* **NOTE**: Internal use only. This type is reserved for Workspace Browser implementation.
|
8797
|
-
*
|
8798
|
-
* Responsible for handling all layout management and renderering
|
8799
|
-
*/
|
8800
|
-
declare type LayoutInstance = {
|
8801
|
-
identity: LayoutIdentity;
|
8802
|
-
getFrameSnapshot: () => Promise<LayoutOptions>;
|
8803
|
-
addView: (payload: AddViewOptions) => Promise<View_2>;
|
8804
|
-
closeView: (viewIdentity: Identity_5) => Promise<void>;
|
8805
|
-
removeView: (viewConfig: Identity_5 | ViewState) => Promise<View_2>;
|
8806
|
-
replaceView: (payload: ReplaceViewOptions) => Promise<View_2>;
|
8807
|
-
getViews: () => LayoutComponent[];
|
8808
|
-
getCurrentViews: () => Identity_5[];
|
8809
|
-
startReplaceLayout: (payload: ReplaceLayoutOptions) => Promise<void>;
|
8810
|
-
applyPreset: (payload: PresetLayoutOptions_2) => void;
|
8811
|
-
isVisible: () => boolean;
|
8812
|
-
destroy: () => Promise<void>;
|
8813
|
-
};
|
8814
|
-
|
8815
8596
|
/**
|
8816
8597
|
* Represents the arrangement of Views within a Platform window's Layout. We do not recommend trying
|
8817
8598
|
* to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot}.
|
@@ -8839,7 +8620,7 @@ declare type LayoutItemConfig = {
|
|
8839
8620
|
*
|
8840
8621
|
* **NOTE**: Internal use only. This type is reserved for Workspace Browser implementation.
|
8841
8622
|
*
|
8842
|
-
* Responsible for
|
8623
|
+
* Responsible for aggregating all layout snapshots and storing layout instances
|
8843
8624
|
*/
|
8844
8625
|
declare interface LayoutManager<T extends LayoutSnapshot> {
|
8845
8626
|
/**
|
@@ -8863,16 +8644,6 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
|
|
8863
8644
|
* @throws if Object.keys(snapshot).length > 1
|
8864
8645
|
*/
|
8865
8646
|
applyLayoutSnapshot(snapshot: T): Promise<void>;
|
8866
|
-
/**
|
8867
|
-
* Called at the start of layout initialization. Adds a new LayoutInstance if the snapshot
|
8868
|
-
* contains a single layout.
|
8869
|
-
*
|
8870
|
-
* Throws if the snapshot contains more than 1 layout, it is expected that the user handles calling
|
8871
|
-
* fin.Platform.Layout.create() once for each layout to properly connect it to their UI state.
|
8872
|
-
*
|
8873
|
-
* @param snapshot
|
8874
|
-
* @throws if Object.keys(snapshot).length > 1
|
8875
|
-
*/
|
8876
8647
|
/**
|
8877
8648
|
* @experimental
|
8878
8649
|
*
|
@@ -8893,31 +8664,49 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
|
|
8893
8664
|
/**
|
8894
8665
|
* @experimental
|
8895
8666
|
*
|
8896
|
-
*
|
8897
|
-
*
|
8667
|
+
* A hook provided to the consumer for controlling how OpenFin routes Layout API calls. Override
|
8668
|
+
* this method to control the target layout for Layout API calls.
|
8669
|
+
*
|
8670
|
+
* Example use case: You have hidden all the layouts and are showing a dialog that will
|
8671
|
+
* execute an API call (ex: Layout.replace()) - override this method and save the
|
8672
|
+
* "last visible" layout identity and return it.
|
8673
|
+
*
|
8674
|
+
* By default, OpenFin will use a series of checks to determine which Layout the API
|
8675
|
+
* call must route to in this order of precedence:
|
8676
|
+
* - try to resolve the layout from the layoutIdentity, throws if missing
|
8677
|
+
* - if there is only 1 layout, resolves that one
|
8678
|
+
* - enumerates all layouts checks visibility via element offsetTop/Left + window.innerHeight/Width
|
8679
|
+
* - returns undefined
|
8680
|
+
*
|
8681
|
+
* @param identity
|
8682
|
+
* @returns LayoutIdentity | undefined
|
8898
8683
|
*/
|
8899
|
-
|
8684
|
+
resolveLayoutIdentity(identity?: Identity_5 | LayoutIdentity): LayoutIdentity | undefined;
|
8900
8685
|
/**
|
8901
8686
|
* @experimental
|
8902
8687
|
*
|
8903
|
-
*
|
8904
|
-
*
|
8905
|
-
*
|
8906
|
-
*
|
8688
|
+
* A hook provided to the consumer when it's time to remove a layout. Use this hook to
|
8689
|
+
* update your local state and remove the layout for the given LayoutIdentity. Note that
|
8690
|
+
* this hook does not call `fin.Platform.Layout.destroy()` for you, instead it is to
|
8691
|
+
* signify to your application it's time to destroy this layout.
|
8692
|
+
*
|
8693
|
+
* 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.
|
8694
|
+
*
|
8695
|
+
* @param LayoutIdentity
|
8907
8696
|
*/
|
8908
|
-
|
8697
|
+
removeLayout({ layoutName }: LayoutIdentity): Promise<void>;
|
8909
8698
|
/**
|
8910
8699
|
* @experimental
|
8911
8700
|
*/
|
8912
|
-
|
8701
|
+
getLayoutIdentityForView(viewIdentity: Identity_5): LayoutIdentity;
|
8913
8702
|
/**
|
8914
8703
|
* @experimental
|
8915
8704
|
*/
|
8916
|
-
|
8705
|
+
isLayoutVisible({ layoutName }: LayoutIdentity): boolean;
|
8917
8706
|
/**
|
8918
8707
|
* @experimental
|
8919
8708
|
*/
|
8920
|
-
|
8709
|
+
size(): number;
|
8921
8710
|
}
|
8922
8711
|
|
8923
8712
|
/**
|
@@ -8964,7 +8753,7 @@ declare class LayoutModule extends Base {
|
|
8964
8753
|
* const layoutConfig = await layout.getConfig();
|
8965
8754
|
* ```
|
8966
8755
|
*/
|
8967
|
-
wrap(identity: OpenFin.LayoutIdentity): Promise<OpenFin.Layout>;
|
8756
|
+
wrap(identity: OpenFin.Identity | OpenFin.LayoutIdentity): Promise<OpenFin.Layout>;
|
8968
8757
|
/**
|
8969
8758
|
* Synchronously returns a Layout object that represents a Window's layout.
|
8970
8759
|
*
|
@@ -8984,7 +8773,7 @@ declare class LayoutModule extends Base {
|
|
8984
8773
|
* const layoutConfig = await layout.getConfig();
|
8985
8774
|
* ```
|
8986
8775
|
*/
|
8987
|
-
wrapSync(identity: OpenFin.LayoutIdentity): OpenFin.Layout;
|
8776
|
+
wrapSync(identity: OpenFin.Identity | OpenFin.LayoutIdentity): OpenFin.Layout;
|
8988
8777
|
/**
|
8989
8778
|
* Asynchronously returns a Layout object that represents a Window's layout.
|
8990
8779
|
*
|
@@ -9156,6 +8945,15 @@ declare abstract class LayoutNode {
|
|
9156
8945
|
/**
|
9157
8946
|
* Creates a new TabStack adjacent to the given TabStack or ColumnOrRow. Inputs can be new views to create, or existing views.
|
9158
8947
|
*
|
8948
|
+
* Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
|
8949
|
+
* during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
|
8950
|
+
* This means the views you pass to createAdjacentStack() may not render in the order given by the array.
|
8951
|
+
* Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
|
8952
|
+
*
|
8953
|
+
* @param views The views that will populate the new TabStack.
|
8954
|
+
* @param options Additional options that control new TabStack creation.
|
8955
|
+
* @returns The newly-created TabStack.
|
8956
|
+
*
|
9159
8957
|
* @example
|
9160
8958
|
* ```js
|
9161
8959
|
* if (!fin.me.isView) {
|
@@ -9190,12 +8988,15 @@ declare abstract class LayoutNode {
|
|
9190
8988
|
* console.log(`A new TabStack created to the right has ${newStack.length} views in it`);
|
9191
8989
|
*
|
9192
8990
|
* ```
|
8991
|
+
* @experimental
|
9193
8992
|
*/
|
9194
8993
|
createAdjacentStack: (views: OpenFin.PlatformViewCreationOptions[], options: {
|
9195
8994
|
position?: OpenFin.LayoutPosition;
|
9196
8995
|
}) => Promise<TabStack>;
|
9197
8996
|
/**
|
9198
|
-
* Retrieves the adjacent TabStacks of the given TabStack or ColumnOrRow
|
8997
|
+
* Retrieves the adjacent TabStacks of the given TabStack or ColumnOrRow.
|
8998
|
+
*
|
8999
|
+
* @param edge Edge whose adjacent TabStacks will be returned.
|
9199
9000
|
*
|
9200
9001
|
* @example
|
9201
9002
|
* ```js
|
@@ -9215,6 +9016,7 @@ declare abstract class LayoutNode {
|
|
9215
9016
|
* console.log(`The entity has ${rightStacks.length} stacks to the right, and ${leftStacks.length} stacks to the left`);
|
9216
9017
|
*
|
9217
9018
|
* ```
|
9019
|
+
* @experimental
|
9218
9020
|
*/
|
9219
9021
|
getAdjacentStacks: (edge: OpenFin.LayoutPosition) => Promise<TabStack[]>;
|
9220
9022
|
}
|
@@ -9238,7 +9040,7 @@ declare type LayoutOptions = {
|
|
9238
9040
|
* @defaultValue false
|
9239
9041
|
*
|
9240
9042
|
* Limits the area to which tabs can be dragged.
|
9241
|
-
* If true,
|
9043
|
+
* If true, the layout container is the only area where tabs can be dropped.
|
9242
9044
|
*/
|
9243
9045
|
constrainDragToContainer?: boolean;
|
9244
9046
|
/**
|
@@ -9309,6 +9111,9 @@ declare type LayoutOptions = {
|
|
9309
9111
|
};
|
9310
9112
|
};
|
9311
9113
|
|
9114
|
+
/**
|
9115
|
+
* Represents the position of an item in a layout relative to another.
|
9116
|
+
*/
|
9312
9117
|
declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
|
9313
9118
|
|
9314
9119
|
/**
|
@@ -9317,11 +9122,12 @@ declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
|
|
9317
9122
|
declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
|
9318
9123
|
|
9319
9124
|
/**
|
9320
|
-
* Generated when
|
9125
|
+
* Generated when the layout and all of the its views have been created and can receive API calls.
|
9321
9126
|
* @interface
|
9322
9127
|
*/
|
9323
|
-
declare type LayoutReadyEvent =
|
9128
|
+
declare type LayoutReadyEvent = BaseEvent_5 & {
|
9324
9129
|
type: 'layout-ready';
|
9130
|
+
layoutIdentity: OpenFin.LayoutIdentity;
|
9325
9131
|
views: (OpenFin.Identity & {
|
9326
9132
|
success: boolean;
|
9327
9133
|
})[];
|
@@ -9461,7 +9267,7 @@ declare type Manifest = {
|
|
9461
9267
|
* Generated when the RVM notifies an application that the manifest has changed.
|
9462
9268
|
* @interface
|
9463
9269
|
*/
|
9464
|
-
declare type ManifestChangedEvent = IdentityEvent & {
|
9270
|
+
declare type ManifestChangedEvent = BaseEvents.IdentityEvent & {
|
9465
9271
|
topic: 'application';
|
9466
9272
|
type: 'manifest-changed';
|
9467
9273
|
};
|
@@ -9514,7 +9320,7 @@ declare type MatchPattern = string;
|
|
9514
9320
|
* Generated when a window is maximized.
|
9515
9321
|
* @interface
|
9516
9322
|
*/
|
9517
|
-
declare type MaximizedEvent =
|
9323
|
+
declare type MaximizedEvent = BaseEvent_5 & {
|
9518
9324
|
type: 'maximized';
|
9519
9325
|
};
|
9520
9326
|
|
@@ -9624,7 +9430,7 @@ declare type MessagingProtocols = ProtocolOffer['type'];
|
|
9624
9430
|
* Generated when a window is minimized.
|
9625
9431
|
* @interface
|
9626
9432
|
*/
|
9627
|
-
declare type MinimizedEvent =
|
9433
|
+
declare type MinimizedEvent = BaseEvent_5 & {
|
9628
9434
|
type: 'minimized';
|
9629
9435
|
};
|
9630
9436
|
|
@@ -9668,14 +9474,9 @@ declare type MonitorDetails = {
|
|
9668
9474
|
};
|
9669
9475
|
|
9670
9476
|
/**
|
9671
|
-
*
|
9672
|
-
* @remarks A monitor's size changes when the taskbar is resized or relocated.
|
9673
|
-
* The available space of a monitor defines a rectangle that is not occupied by the taskbar
|
9674
|
-
* @interface
|
9477
|
+
* @deprecated Renamed to {@link MonitorInfoChangedEvent}.
|
9675
9478
|
*/
|
9676
|
-
declare type MonitorEvent =
|
9677
|
-
type: 'monitor-info-changed';
|
9678
|
-
};
|
9479
|
+
declare type MonitorEvent = MonitorInfoChangedEvent;
|
9679
9480
|
|
9680
9481
|
/**
|
9681
9482
|
* @interface
|
@@ -9699,6 +9500,16 @@ declare type MonitorInfo = {
|
|
9699
9500
|
virtualScreen: DipRect;
|
9700
9501
|
};
|
9701
9502
|
|
9503
|
+
/**
|
9504
|
+
* Generated on changes of a monitor's size/location.
|
9505
|
+
* @remarks A monitor's size changes when the taskbar is resized or relocated.
|
9506
|
+
* The available space of a monitor defines a rectangle that is not occupied by the taskbar
|
9507
|
+
* @interface
|
9508
|
+
*/
|
9509
|
+
declare type MonitorInfoChangedEvent = BaseEvent_8 & OpenFin.MonitorInfo & {
|
9510
|
+
type: 'monitor-info-changed';
|
9511
|
+
};
|
9512
|
+
|
9702
9513
|
/**
|
9703
9514
|
* @interface
|
9704
9515
|
*/
|
@@ -10029,7 +9840,7 @@ declare type MutableWindowOptions = {
|
|
10029
9840
|
* Used by Workspace to store custom data. Overwriting or modifying this field may impact the functionality of Workspace
|
10030
9841
|
*/
|
10031
9842
|
_internalWorkspaceData: any;
|
10032
|
-
workspacePlatform:
|
9843
|
+
workspacePlatform: unknown;
|
10033
9844
|
};
|
10034
9845
|
|
10035
9846
|
declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;
|
@@ -10105,14 +9916,23 @@ declare type NonPropagatedWindowEvent = never;
|
|
10105
9916
|
|
10106
9917
|
/**
|
10107
9918
|
* @internal
|
9919
|
+
*
|
9920
|
+
* Ensures that an event type key does not include any `close-requested` events. Distributes over unions.
|
9921
|
+
*/
|
9922
|
+
declare type NotCloseRequested<EventType extends string> = Exclude<EventType, 'close-requested'>;
|
9923
|
+
|
9924
|
+
/**
|
9925
|
+
* @internal
|
9926
|
+
*
|
9927
|
+
* Ensures that an event type key doesn't include any `-requested` events. Distributes over unions.
|
10108
9928
|
*/
|
10109
|
-
declare type NotRequested<EventType> = EventType extends `${
|
9929
|
+
declare type NotRequested<EventType extends String> = EventType extends `${string}-requested` ? never : EventType;
|
10110
9930
|
|
10111
9931
|
/**
|
10112
9932
|
* Generated when an application is not responding.
|
10113
9933
|
* @interface
|
10114
9934
|
*/
|
10115
|
-
declare type NotRespondingEvent = IdentityEvent & {
|
9935
|
+
declare type NotRespondingEvent = BaseEvents.IdentityEvent & {
|
10116
9936
|
topic: 'application';
|
10117
9937
|
type: 'not-responding';
|
10118
9938
|
};
|
@@ -10263,6 +10083,7 @@ declare namespace OpenFin {
|
|
10263
10083
|
WebPermission,
|
10264
10084
|
VerboseWebPermission,
|
10265
10085
|
OpenExternalPermission,
|
10086
|
+
DeviceInfo,
|
10266
10087
|
Permissions_2 as Permissions,
|
10267
10088
|
PlatformWindowCreationOptions,
|
10268
10089
|
PlatformWindowOptions,
|
@@ -10420,7 +10241,6 @@ declare namespace OpenFin {
|
|
10420
10241
|
InitLayoutOptions,
|
10421
10242
|
LayoutManagerConstructor,
|
10422
10243
|
LayoutManagerOverride,
|
10423
|
-
LayoutInstance,
|
10424
10244
|
LayoutManager,
|
10425
10245
|
CreateLayoutOptions,
|
10426
10246
|
PresetLayoutOptions_2 as PresetLayoutOptions,
|
@@ -10438,7 +10258,7 @@ declare namespace OpenFin {
|
|
10438
10258
|
AppVersionCompleteEvent,
|
10439
10259
|
AppVersionRuntimeStatusEvent,
|
10440
10260
|
Events,
|
10441
|
-
|
10261
|
+
BaseEvent_9 as BaseEvent,
|
10442
10262
|
WebContentsEvent_2 as WebContentsEvent,
|
10443
10263
|
SystemEvent_2 as SystemEvent,
|
10444
10264
|
ApplicationEvent_2 as ApplicationEvent,
|
@@ -10480,12 +10300,32 @@ export default OpenFin;
|
|
10480
10300
|
|
10481
10301
|
declare type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
|
10482
10302
|
|
10303
|
+
/**
|
10304
|
+
* Generated after window options are changed using the window.updateOptions method.
|
10305
|
+
* @remarks Will not fire if the diff object is empty.
|
10306
|
+
* @interface
|
10307
|
+
*/
|
10308
|
+
declare type OptionsChangedEvent = BaseEvent_5 & {
|
10309
|
+
type: 'options-changed';
|
10310
|
+
options: OpenFin.WindowOptions;
|
10311
|
+
diff: OpenFin.WindowOptionDiff;
|
10312
|
+
};
|
10313
|
+
|
10483
10314
|
declare type OverlapsOnlyIfMatching<T, U> = {
|
10484
10315
|
[K in Extract<keyof T, keyof U>]: U[K] extends T[K] ? U[K] : T[K] extends U[K] ? T[K] : never;
|
10485
10316
|
};
|
10486
10317
|
|
10487
10318
|
declare type OverrideCallback<T extends any = PlatformProvider, U extends T = T> = (arg: Constructor<T>) => U | Promise<U>;
|
10488
10319
|
|
10320
|
+
/**
|
10321
|
+
* Generated when page receives favicon urls.
|
10322
|
+
* @interface
|
10323
|
+
*/
|
10324
|
+
declare type PageFaviconUpdatedEvent = NamedEvent & {
|
10325
|
+
type: 'page-favicon-updated';
|
10326
|
+
favicons: string[];
|
10327
|
+
};
|
10328
|
+
|
10489
10329
|
/**
|
10490
10330
|
* Generated when page title is set during navigation.
|
10491
10331
|
* @remarks explicitSet is false when title is synthesized from file url.
|
@@ -10504,74 +10344,74 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
|
|
10504
10344
|
};
|
10505
10345
|
|
10506
10346
|
/**
|
10507
|
-
* Extracts a single event type matching the given key from the {@link
|
10347
|
+
* Extracts a single event type matching the given key from the View {@link Event} union.
|
10508
10348
|
*
|
10509
10349
|
* @typeParam Type String key specifying the event to extract
|
10510
10350
|
*/
|
10511
|
-
declare type Payload_2<Type extends
|
10351
|
+
declare type Payload_2<Type extends EventType> = Extract<Event_4, {
|
10512
10352
|
type: Type;
|
10513
10353
|
}>;
|
10514
10354
|
|
10515
10355
|
/**
|
10516
|
-
* Extracts a single event type matching the given key from the {@link
|
10356
|
+
* Extracts a single event type matching the given key from the Window {@link Event} union.
|
10517
10357
|
*
|
10518
10358
|
* @typeParam Type String key specifying the event to extract
|
10519
10359
|
*/
|
10520
|
-
declare type Payload_3<Type extends
|
10360
|
+
declare type Payload_3<Type extends EventType_2> = Extract<Event_6, {
|
10521
10361
|
type: Type;
|
10522
10362
|
}>;
|
10523
10363
|
|
10524
10364
|
/**
|
10525
|
-
* Extracts a single event type matching the given key from the {@link
|
10365
|
+
* Extracts a single event type matching the given key from the Application {@link Event} union.
|
10526
10366
|
*
|
10527
10367
|
* @typeParam Type String key specifying the event to extract
|
10528
10368
|
*/
|
10529
|
-
declare type Payload_4<Type extends
|
10369
|
+
declare type Payload_4<Type extends EventType_3> = Extract<Event_3, {
|
10530
10370
|
type: Type;
|
10531
10371
|
}>;
|
10532
10372
|
|
10533
10373
|
/**
|
10534
|
-
* Extracts a single event type matching the given key from the {@link
|
10374
|
+
* Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
|
10535
10375
|
*
|
10536
10376
|
* @typeParam Type String key specifying the event to extract
|
10537
10377
|
*/
|
10538
|
-
declare type Payload_5<Type extends
|
10378
|
+
declare type Payload_5<Type extends EventType_4> = Extract<Event_7, {
|
10539
10379
|
type: Type;
|
10540
10380
|
}>;
|
10541
10381
|
|
10542
10382
|
/**
|
10543
|
-
* Extracts a single event type matching the given key from the {@link
|
10383
|
+
* Extracts a single event type matching the given key from the Frame {@link Event} union.
|
10544
10384
|
*
|
10545
10385
|
* @typeParam Type String key specifying the event to extract
|
10546
10386
|
*/
|
10547
|
-
declare type Payload_6<Type extends
|
10387
|
+
declare type Payload_6<Type extends EventType_5> = Extract<Event_8, {
|
10548
10388
|
type: Type;
|
10549
10389
|
}>;
|
10550
10390
|
|
10551
10391
|
/**
|
10552
|
-
* Extracts a single event type matching the given key from the {@link
|
10392
|
+
* Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
|
10553
10393
|
*
|
10554
10394
|
* @typeParam Type String key specifying the event to extract
|
10555
10395
|
*/
|
10556
|
-
declare type Payload_7<Type extends
|
10396
|
+
declare type Payload_7<Type extends EventType_6> = Extract<Event_9, {
|
10557
10397
|
type: Type;
|
10558
10398
|
}>;
|
10559
10399
|
|
10560
10400
|
/**
|
10561
|
-
* Extracts a single event type matching the given key from the {@link
|
10401
|
+
* Extracts a single event type matching the given key from the Platform {@link Event} union.
|
10562
10402
|
*
|
10563
10403
|
* @typeParam Type String key specifying the event to extract
|
10564
10404
|
*/
|
10565
|
-
declare type Payload_8<Type extends
|
10405
|
+
declare type Payload_8<Type extends EventType_7> = Extract<Event_10, {
|
10566
10406
|
type: Type;
|
10567
10407
|
}>;
|
10568
10408
|
|
10569
10409
|
/**
|
10570
|
-
* Extracts a single event type matching the given key from the {@link
|
10410
|
+
* Extracts a single event type matching the given key from the System {@link Event} union.
|
10571
10411
|
*
|
10572
10412
|
* @typeParam Type String key specifying the event to extract
|
10573
10413
|
*/
|
10574
|
-
declare type Payload_9<Type extends
|
10414
|
+
declare type Payload_9<Type extends EventType_8> = Extract<Event_11, {
|
10575
10415
|
type: Type;
|
10576
10416
|
}>;
|
10577
10417
|
|
@@ -10581,7 +10421,7 @@ declare type PayloadTypeByStrategy<T extends ChannelStrategy<unknown>> = T exten
|
|
10581
10421
|
* Generated when window finishes loading. Provides performance and navigation data.
|
10582
10422
|
* @interface
|
10583
10423
|
*/
|
10584
|
-
declare type PerformanceReportEvent = Performance &
|
10424
|
+
declare type PerformanceReportEvent = Performance & BaseEvent_5 & {
|
10585
10425
|
type: 'performance-report';
|
10586
10426
|
};
|
10587
10427
|
|
@@ -10592,6 +10432,7 @@ declare type Permissions_2 = {
|
|
10592
10432
|
Application?: Partial<ApplicationPermissions>;
|
10593
10433
|
System?: Partial<SystemPermissions>;
|
10594
10434
|
webAPIs?: WebPermission[];
|
10435
|
+
devices?: DeviceInfo[];
|
10595
10436
|
};
|
10596
10437
|
|
10597
10438
|
declare type PermissionState_2 = 'granted' | 'denied' | 'unavailable';
|
@@ -11245,38 +11086,36 @@ declare class Platform extends EmitterBase<OpenFin.PlatformEvent> {
|
|
11245
11086
|
}
|
11246
11087
|
|
11247
11088
|
/**
|
11248
|
-
*
|
11249
|
-
* @interface
|
11089
|
+
* @deprecated Renamed to {@link ApiReadyEvent}.
|
11250
11090
|
*/
|
11251
|
-
declare type PlatformApiReadyEvent =
|
11252
|
-
topic: 'application';
|
11253
|
-
type: 'platform-api-ready';
|
11254
|
-
};
|
11091
|
+
declare type PlatformApiReadyEvent = ApiReadyEvent;
|
11255
11092
|
|
11256
11093
|
/**
|
11257
|
-
*
|
11258
|
-
* discriminated by {@link PlatformEvent.type | their type}. Event payloads unique to `Platform` can be found
|
11259
|
-
* under the {@link OpenFin.PlatformEvents} namespace.
|
11094
|
+
* @deprecated Renamed to {@link Event}.
|
11260
11095
|
*/
|
11261
|
-
declare type PlatformEvent =
|
11096
|
+
declare type PlatformEvent = Event_10;
|
11262
11097
|
|
11263
11098
|
declare type PlatformEvent_2 = Events.PlatformEvents.PlatformEvent;
|
11264
11099
|
|
11265
11100
|
declare namespace PlatformEvents {
|
11266
11101
|
export {
|
11102
|
+
ApiReadyEvent,
|
11267
11103
|
PlatformApiReadyEvent,
|
11104
|
+
SnapshotAppliedEvent,
|
11268
11105
|
PlatformSnapshotAppliedEvent,
|
11106
|
+
Event_10 as Event,
|
11269
11107
|
PlatformEvent,
|
11108
|
+
EventType_7 as EventType,
|
11270
11109
|
PlatformEventType,
|
11271
|
-
|
11272
|
-
|
11110
|
+
Payload_8 as Payload,
|
11111
|
+
ByType_7 as ByType
|
11273
11112
|
}
|
11274
11113
|
}
|
11275
11114
|
|
11276
11115
|
/**
|
11277
|
-
*
|
11116
|
+
* @deprecated Renamed to {@link }.
|
11278
11117
|
*/
|
11279
|
-
declare type PlatformEventType =
|
11118
|
+
declare type PlatformEventType = EventType_7;
|
11280
11119
|
|
11281
11120
|
/**
|
11282
11121
|
* Static namespace for OpenFin API methods that interact with the {@link Platform} class, available under `fin.Platform`.
|
@@ -11549,18 +11388,16 @@ declare interface PlatformProvider {
|
|
11549
11388
|
*/
|
11550
11389
|
getInitialLayoutSnapshot(payload: undefined, callerIdentity: OpenFin.Identity): Promise<OpenFin.LayoutSnapshot | undefined>;
|
11551
11390
|
/**
|
11552
|
-
* @experimental
|
11553
|
-
*
|
11554
|
-
* **NOTE**: Internal use only. This method is reserved for Workspace Browser implementation.
|
11555
|
-
*
|
11556
|
-
* Calls platform.createView for every view in the given layout. Returns an array of promises
|
11557
|
-
* one promise for each view create call
|
11391
|
+
* @experimental
|
11558
11392
|
*
|
11559
|
-
* @
|
11560
|
-
*
|
11561
|
-
* @
|
11393
|
+
* This API is called during the {@link PlatformProvider.getSnapshot()} call.
|
11394
|
+
* Gets the current state of a particular window and its views and returns an object that
|
11395
|
+
* can be added to the {@link OpenFin.Snapshot.windows} property. Override this function if
|
11396
|
+
* you wish to mutate each window snapshot during the {@link PlatformProvider.getSnapshot()} call
|
11397
|
+
* @param identity
|
11398
|
+
* @param callerIdentity
|
11562
11399
|
*/
|
11563
|
-
|
11400
|
+
getWindowSnapshot(identity: OpenFin.Identity, callerIdentity: OpenFin.Identity): Promise<OpenFin.WindowCreationOptions>;
|
11564
11401
|
/**
|
11565
11402
|
* **NOTE**: Internal use only. It is not recommended to manage the state of individual views.
|
11566
11403
|
* Gets the current state of a single view and returns an object with the options needed to restore that view as part of a snapshot.
|
@@ -12001,19 +11838,9 @@ declare interface PlatformProvider {
|
|
12001
11838
|
}
|
12002
11839
|
|
12003
11840
|
/**
|
12004
|
-
*
|
12005
|
-
* @remarks The call is resolved when the following conditions are met for all windows in the snapshot:
|
12006
|
-
* 1. The window has been created
|
12007
|
-
* 2. The window has a responsive API
|
12008
|
-
* 3. If a window has a layout property, the 'layout-ready' event has fired
|
12009
|
-
*
|
12010
|
-
* _Note_ - In the case of using a custom provider, if a window has a layout property but does not call _Layout.init_ this event may not fire.
|
12011
|
-
* @interface
|
11841
|
+
* @deprecated Renamed to {@link SnapshotAppliedEvent}.
|
12012
11842
|
*/
|
12013
|
-
declare type PlatformSnapshotAppliedEvent =
|
12014
|
-
topic: 'application';
|
12015
|
-
type: 'platform-snapshot-applied';
|
12016
|
-
};
|
11843
|
+
declare type PlatformSnapshotAppliedEvent = SnapshotAppliedEvent;
|
12017
11844
|
|
12018
11845
|
/**
|
12019
11846
|
* @interface
|
@@ -12281,7 +12108,7 @@ declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent &
|
|
12281
12108
|
* A general preload scripts state change event without event type.
|
12282
12109
|
* @interface
|
12283
12110
|
*/
|
12284
|
-
declare type PreloadScriptsStateChangeEvent =
|
12111
|
+
declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
|
12285
12112
|
preloadScripts: (PreloadScriptInfoRunning & any)[];
|
12286
12113
|
};
|
12287
12114
|
|
@@ -12490,51 +12317,43 @@ declare type ProcessLoggingOptions = {
|
|
12490
12317
|
};
|
12491
12318
|
|
12492
12319
|
/**
|
12493
|
-
*
|
12494
|
-
* {@link OpenFin.ApplicationEvents.ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}
|
12495
|
-
* are propagated to `System` without any type string prefixing.
|
12496
|
-
*
|
12497
|
-
* "Requested" events (e.g. {@link RunRequestedEvent}) do not propagate.
|
12320
|
+
* @deprecated Renamed to {@link PropagatedEvent}.
|
12498
12321
|
*/
|
12499
|
-
declare type PropagatedApplicationEvent<TargetTopic extends string> =
|
12322
|
+
declare type PropagatedApplicationEvent<TargetTopic extends string> = PropagatedEvent_4<TargetTopic>;
|
12500
12323
|
|
12501
12324
|
/**
|
12502
|
-
*
|
12325
|
+
* @deprecated Renamed to {@link PropagatedEventType}.
|
12503
12326
|
*/
|
12504
|
-
declare type PropagatedApplicationEventType =
|
12327
|
+
declare type PropagatedApplicationEventType = PropagatedEventType_3;
|
12505
12328
|
|
12506
12329
|
/**
|
12507
|
-
* Modifies an event shape to reflect propagation to a parent topic.
|
12330
|
+
* Modifies an event shape to reflect propagation to a parent topic. Excludes `close-requested` events, as
|
12331
|
+
* these do not propagate.
|
12332
|
+
*
|
12508
12333
|
* @remarks The 'type' field is prefixed with the original topic, and a new property is added with the original topic's identity.
|
12334
|
+
*
|
12335
|
+
* @typeParam SourceTopic The topic the event shape is propagating from.
|
12336
|
+
* @typeParam TargetTopic The topic the event shape is propagating to.
|
12337
|
+
* @typeParam Event The shape of the event being propagated.
|
12509
12338
|
*/
|
12510
12339
|
declare type PropagatedEvent<SourceTopic extends string, TargetTopic extends string, Event extends {
|
12511
12340
|
type: string;
|
12512
12341
|
}> = Event extends infer E extends {
|
12513
12342
|
type: string;
|
12514
|
-
} ? Omit<E, 'type' | 'topic'> & {
|
12343
|
+
} ? E['type'] extends 'close-requested' ? never : Omit<E, 'type' | 'topic'> & {
|
12515
12344
|
type: PropagatedEventType<SourceTopic, E['type']>;
|
12516
12345
|
topic: TargetTopic;
|
12517
12346
|
} : never;
|
12518
12347
|
|
12519
|
-
/**
|
12520
|
-
* Modifies an event key to reflect propagation by prefixing with the topic.
|
12521
|
-
*/
|
12522
|
-
declare type PropagatedEventType<Topic extends string, Type extends string> = `${Topic}-${Type}`;
|
12523
|
-
|
12524
12348
|
/**
|
12525
12349
|
* A view event that has propagated to a parent {@link OpenFin.WindowEvents Window}, {@link OpenFin.ApplicationEvents Application},
|
12526
12350
|
* or {@link OpenFin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
|
12527
12351
|
* event type key with `'view-'`.
|
12528
12352
|
*/
|
12529
|
-
declare type
|
12353
|
+
declare type PropagatedEvent_2<TargetTopic extends string> = BaseEvents.PropagatedEvent<'view', TargetTopic, ViewEvent> & {
|
12530
12354
|
viewIdentity: OpenFin.Identity;
|
12531
12355
|
};
|
12532
12356
|
|
12533
|
-
/**
|
12534
|
-
* Union of possible `type` values for a {@link OpenFin.ViewEvents.PropagatedViewEvent}.
|
12535
|
-
*/
|
12536
|
-
declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
|
12537
|
-
|
12538
12357
|
/**
|
12539
12358
|
* A Window event that has propagated to the parent {@link OpenFin.ApplicationEvents Application} and {@link OpenFin.SystemEvents System},
|
12540
12359
|
* prefixing the type string with `'window-'`. Only {@link WindowSourcedEvent window-sourced events} will propagate
|
@@ -12543,12 +12362,51 @@ declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
|
|
12543
12362
|
*
|
12544
12363
|
* "Requested" events (e.g. {@link AuthRequestedEvent}) do not propagate to `System.`
|
12545
12364
|
*/
|
12546
|
-
declare type
|
12365
|
+
declare type PropagatedEvent_3<TargetTopic extends string> = BaseEvents.PropagatedEvent<'window', TargetTopic, WindowSourcedEvent>;
|
12366
|
+
|
12367
|
+
/**
|
12368
|
+
* An Application event that has propagated to {@link OpenFin.SystemEvents System}, type string prefixed with `application-`.
|
12369
|
+
* {@link OpenFin.ApplicationEvents.ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}
|
12370
|
+
* are propagated to `System` without any type string prefixing.
|
12371
|
+
*
|
12372
|
+
* "Requested" events (e.g. {@link RunRequestedEvent}) do not propagate.
|
12373
|
+
*/
|
12374
|
+
declare type PropagatedEvent_4<TargetTopic extends string> = BaseEvents.PropagatedEvent<'application', TargetTopic, ApplicationSourcedEvent> | ApplicationWindowEvent;
|
12375
|
+
|
12376
|
+
/**
|
12377
|
+
* Modifies an event type key to reflect propagation by prefixing with the topic.
|
12378
|
+
*/
|
12379
|
+
declare type PropagatedEventType<Topic extends string, Type extends string> = `${Topic}-${NotCloseRequested<Type>}`;
|
12380
|
+
|
12381
|
+
/**
|
12382
|
+
* Union of possible `type` values for a {@link PropagatedEvent} sourced from a {@link OpenFin.View}.
|
12383
|
+
*/
|
12384
|
+
declare type PropagatedEventType_2 = PropagatedEvent_2<string>['type'];
|
12385
|
+
|
12386
|
+
/**
|
12387
|
+
* Union of possible 'type' values for an {@link PropagatedEvent} sourced from an {@link Application}.
|
12388
|
+
*/
|
12389
|
+
declare type PropagatedEventType_3 = PropagatedEvent_4<string>['type'];
|
12390
|
+
|
12391
|
+
/**
|
12392
|
+
* @deprecated Renamed to {@link PropagatedEvent}.
|
12393
|
+
*/
|
12394
|
+
declare type PropagatedViewEvent<TargetTopic extends string> = PropagatedEvent_2<TargetTopic>;
|
12395
|
+
|
12396
|
+
/**
|
12397
|
+
* @deprecated Renamed to {@link PropagatedEventType}.
|
12398
|
+
*/
|
12399
|
+
declare type PropagatedViewEventType = PropagatedEventType_2;
|
12400
|
+
|
12401
|
+
/**
|
12402
|
+
* @deprecated Renamed to {@link PropagatedEvent}.
|
12403
|
+
*/
|
12404
|
+
declare type PropagatedWindowEvent<TargetTopic extends string> = PropagatedEvent_3<TargetTopic>;
|
12547
12405
|
|
12548
12406
|
/**
|
12549
|
-
* Union of possible `type` values for a {@link OpenFin.
|
12407
|
+
* Union of possible `type` values for a {@link PropagatedEvent} sourced from a {@link OpenFin.Window}.
|
12550
12408
|
*/
|
12551
|
-
declare type PropagatedWindowEventType =
|
12409
|
+
declare type PropagatedWindowEventType = PropagatedEvent_3<string>['type'];
|
12552
12410
|
|
12553
12411
|
declare interface ProtocolMap extends ProtocolMapBase {
|
12554
12412
|
'request-external-authorization': {
|
@@ -12966,7 +12824,7 @@ declare type RegistryInfo_2 = {
|
|
12966
12824
|
* Generated when a window has been reloaded.
|
12967
12825
|
* @interface
|
12968
12826
|
*/
|
12969
|
-
declare type ReloadedEvent =
|
12827
|
+
declare type ReloadedEvent = BaseEvent_5 & {
|
12970
12828
|
type: 'reloaded';
|
12971
12829
|
url: string;
|
12972
12830
|
};
|
@@ -13003,7 +12861,7 @@ declare type ReplaceLayoutPayload = {
|
|
13003
12861
|
/**
|
13004
12862
|
* Identity of the window whose layout will be replaced.
|
13005
12863
|
*/
|
13006
|
-
target: LayoutIdentity;
|
12864
|
+
target: Identity_5 | LayoutIdentity;
|
13007
12865
|
};
|
13008
12866
|
|
13009
12867
|
/**
|
@@ -13102,11 +12960,19 @@ declare type ResourceResponseReceivedEvent = NamedEvent & {
|
|
13102
12960
|
* Generated when an application is responding.
|
13103
12961
|
* @interface
|
13104
12962
|
*/
|
13105
|
-
declare type RespondingEvent = IdentityEvent & {
|
12963
|
+
declare type RespondingEvent = BaseEvents.IdentityEvent & {
|
13106
12964
|
topic: 'application';
|
13107
12965
|
type: 'responding';
|
13108
12966
|
};
|
13109
12967
|
|
12968
|
+
/**
|
12969
|
+
* Generated when a window is displayed after having been minimized or when a window leaves the maximize state without minimizing.
|
12970
|
+
* @interface
|
12971
|
+
*/
|
12972
|
+
declare type RestoredEvent = BaseEvent_5 & {
|
12973
|
+
type: 'restored';
|
12974
|
+
};
|
12975
|
+
|
13110
12976
|
declare type ResultBehavior = 'close' | 'hide' | 'none';
|
13111
12977
|
|
13112
12978
|
/**
|
@@ -13169,7 +13035,7 @@ declare type RunRequestedEvent = OpenFin.ApplicationEvents.RunRequestedEvent;
|
|
13169
13035
|
* Generated when Application.run() is called for an already running application.
|
13170
13036
|
* @interface
|
13171
13037
|
*/
|
13172
|
-
declare type RunRequestedEvent_2 = IdentityEvent & {
|
13038
|
+
declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
|
13173
13039
|
topic: 'application';
|
13174
13040
|
type: 'run-requested';
|
13175
13041
|
userAppConfigArgs: Record<string, any>;
|
@@ -13351,7 +13217,7 @@ declare type ServiceIdentifier = {
|
|
13351
13217
|
* Generated on changes to a user’s local computer session.
|
13352
13218
|
* @interface
|
13353
13219
|
*/
|
13354
|
-
declare type SessionChangedEvent =
|
13220
|
+
declare type SessionChangedEvent = BaseEvent_8 & {
|
13355
13221
|
type: 'session-changed';
|
13356
13222
|
reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
|
13357
13223
|
};
|
@@ -13573,7 +13439,7 @@ declare type ShortcutOverride = Hotkey & {
|
|
13573
13439
|
*
|
13574
13440
|
* @interface
|
13575
13441
|
*/
|
13576
|
-
declare type ShowAllDownloadsEvent =
|
13442
|
+
declare type ShowAllDownloadsEvent = BaseEvent_5 & {
|
13577
13443
|
type: 'show-all-downloads';
|
13578
13444
|
};
|
13579
13445
|
|
@@ -13581,7 +13447,15 @@ declare type ShowAllDownloadsEvent = BaseWindowEvent & {
|
|
13581
13447
|
* Generated when a View is shown. This event will fire during creation of a View.
|
13582
13448
|
* @interface
|
13583
13449
|
*/
|
13584
|
-
declare type ShownEvent =
|
13450
|
+
declare type ShownEvent = BaseEvent_4 & {
|
13451
|
+
type: 'shown';
|
13452
|
+
};
|
13453
|
+
|
13454
|
+
/**
|
13455
|
+
* Generated when a hidden window has been shown.
|
13456
|
+
* @interface
|
13457
|
+
*/
|
13458
|
+
declare type ShownEvent_2 = BaseEvent_5 & {
|
13585
13459
|
type: 'shown';
|
13586
13460
|
};
|
13587
13461
|
|
@@ -13610,6 +13484,15 @@ declare type ShowPopupMenuOptions<Data extends unknown = unknown> = {
|
|
13610
13484
|
y?: number;
|
13611
13485
|
};
|
13612
13486
|
|
13487
|
+
/**
|
13488
|
+
* Generated when a window has been prevented from showing.
|
13489
|
+
* @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.
|
13490
|
+
* @interface
|
13491
|
+
*/
|
13492
|
+
declare type ShowRequestedEvent = BaseEvent_5 & {
|
13493
|
+
type: 'show-requested';
|
13494
|
+
};
|
13495
|
+
|
13613
13496
|
/**
|
13614
13497
|
* _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
|
13615
13498
|
*
|
@@ -13656,6 +13539,21 @@ declare type Snapshot = {
|
|
13656
13539
|
};
|
13657
13540
|
};
|
13658
13541
|
|
13542
|
+
/**
|
13543
|
+
* Generated when a platform.ApplySnapshot call is resolved.
|
13544
|
+
* @remarks The call is resolved when the following conditions are met for all windows in the snapshot:
|
13545
|
+
* 1. The window has been created
|
13546
|
+
* 2. The window has a responsive API
|
13547
|
+
* 3. If a window has a layout property, the 'layout-ready' event has fired
|
13548
|
+
*
|
13549
|
+
* _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.
|
13550
|
+
* @interface
|
13551
|
+
*/
|
13552
|
+
declare type SnapshotAppliedEvent = BaseEvent & {
|
13553
|
+
topic: 'application';
|
13554
|
+
type: 'platform-snapshot-applied';
|
13555
|
+
};
|
13556
|
+
|
13659
13557
|
/**
|
13660
13558
|
* @interface
|
13661
13559
|
*/
|
@@ -13773,7 +13671,7 @@ declare class SnapshotSourceModule extends Base {
|
|
13773
13671
|
* Generated when an application has started.
|
13774
13672
|
* @interface
|
13775
13673
|
*/
|
13776
|
-
declare type StartedEvent = IdentityEvent & {
|
13674
|
+
declare type StartedEvent = BaseEvents.IdentityEvent & {
|
13777
13675
|
topic: 'application';
|
13778
13676
|
type: 'started';
|
13779
13677
|
};
|
@@ -13800,83 +13698,6 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
13800
13698
|
*/
|
13801
13699
|
constructor(wire: Transport);
|
13802
13700
|
private sendExternalProcessRequest;
|
13803
|
-
/**
|
13804
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
13805
|
-
* @param eventType - The type of the event.
|
13806
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
13807
|
-
* @param options - Option to support event timestamps.
|
13808
|
-
*
|
13809
|
-
* @function addListener
|
13810
|
-
* @memberof System
|
13811
|
-
* @instance
|
13812
|
-
* @tutorial System.EventEmitter
|
13813
|
-
*/
|
13814
|
-
/**
|
13815
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
13816
|
-
* @param eventType - The type of the event.
|
13817
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
13818
|
-
* @param options - Option to support event timestamps.
|
13819
|
-
*
|
13820
|
-
* @function on
|
13821
|
-
* @memberof System
|
13822
|
-
* @instance
|
13823
|
-
* @tutorial System.EventEmitter
|
13824
|
-
*/
|
13825
|
-
/**
|
13826
|
-
* 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.
|
13827
|
-
* @param eventType - The type of the event.
|
13828
|
-
* @param listener - The callback function.
|
13829
|
-
* @param options - Option to support event timestamps.
|
13830
|
-
*
|
13831
|
-
* @function once
|
13832
|
-
* @memberof System
|
13833
|
-
* @instance
|
13834
|
-
* @tutorial System.EventEmitter
|
13835
|
-
*/
|
13836
|
-
/**
|
13837
|
-
* Adds a listener to the beginning of the listeners array for the specified event.
|
13838
|
-
* @param eventType - The type of the event.
|
13839
|
-
* @param listener - The callback function.
|
13840
|
-
* @param options - Option to support event timestamps.
|
13841
|
-
*
|
13842
|
-
* @function prependListener
|
13843
|
-
* @memberof System
|
13844
|
-
* @instance
|
13845
|
-
* @tutorial System.EventEmitter
|
13846
|
-
*/
|
13847
|
-
/**
|
13848
|
-
* 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.
|
13849
|
-
* The listener is added to the beginning of the listeners array.
|
13850
|
-
* @param eventType - The type of the event.
|
13851
|
-
* @param listener - The callback function.
|
13852
|
-
* @param options - Option to support event timestamps.
|
13853
|
-
*
|
13854
|
-
* @function prependOnceListener
|
13855
|
-
* @memberof System
|
13856
|
-
* @instance
|
13857
|
-
* @tutorial System.EventEmitter
|
13858
|
-
*/
|
13859
|
-
/**
|
13860
|
-
* Remove a listener from the listener array for the specified event.
|
13861
|
-
* Caution: Calling this method changes the array indices in the listener array behind the listener.
|
13862
|
-
* @param eventType - The type of the event.
|
13863
|
-
* @param listener - The callback function.
|
13864
|
-
* @param options - Option to support event timestamps.
|
13865
|
-
*
|
13866
|
-
* @function removeListener
|
13867
|
-
* @memberof System
|
13868
|
-
* @instance
|
13869
|
-
* @tutorial System.EventEmitter
|
13870
|
-
*/
|
13871
|
-
/**
|
13872
|
-
* Removes all listeners, or those of the specified event.
|
13873
|
-
* @param eventType - The type of the event.
|
13874
|
-
*
|
13875
|
-
* @function removeAllListeners
|
13876
|
-
* @memberof System
|
13877
|
-
* @instance
|
13878
|
-
* @tutorial System.EventEmitter
|
13879
|
-
*/
|
13880
13701
|
/**
|
13881
13702
|
* Returns the version of the runtime. The version contains the major, minor,
|
13882
13703
|
* build and revision numbers.
|
@@ -15309,12 +15130,9 @@ declare type SystemChannel = Omit<Channel_3, 'addContextListener' | 'broadcast'
|
|
15309
15130
|
};
|
15310
15131
|
|
15311
15132
|
/**
|
15312
|
-
*
|
15313
|
-
* discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
|
15314
|
-
* under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
15315
|
-
* from which they propagate).
|
15133
|
+
* @deprecated Renamed to {@link Event}.
|
15316
15134
|
*/
|
15317
|
-
declare type SystemEvent =
|
15135
|
+
declare type SystemEvent = Event_11;
|
15318
15136
|
|
15319
15137
|
declare type SystemEvent_2 = Events.SystemEvents.SystemEvent;
|
15320
15138
|
|
@@ -15322,8 +15140,10 @@ declare namespace SystemEvents {
|
|
15322
15140
|
export {
|
15323
15141
|
NotRequested,
|
15324
15142
|
ExcludeRequested,
|
15325
|
-
|
15143
|
+
BaseEvent_8 as BaseEvent,
|
15144
|
+
IdleStateChangedEvent,
|
15326
15145
|
IdleEvent,
|
15146
|
+
MonitorInfoChangedEvent,
|
15327
15147
|
MonitorEvent,
|
15328
15148
|
SessionChangedEvent,
|
15329
15149
|
AppVersionEvent,
|
@@ -15337,17 +15157,19 @@ declare namespace SystemEvents {
|
|
15337
15157
|
ApplicationCreatedEvent,
|
15338
15158
|
DesktopIconClickedEvent,
|
15339
15159
|
SystemShutdownEvent,
|
15160
|
+
Event_11 as Event,
|
15340
15161
|
SystemEvent,
|
15162
|
+
EventType_8 as EventType,
|
15341
15163
|
SystemEventType,
|
15342
|
-
|
15343
|
-
|
15164
|
+
Payload_9 as Payload,
|
15165
|
+
ByType_8 as ByType
|
15344
15166
|
}
|
15345
15167
|
}
|
15346
15168
|
|
15347
15169
|
/**
|
15348
|
-
*
|
15170
|
+
* @deprecated Renamed to {@link EventType}.
|
15349
15171
|
*/
|
15350
|
-
declare type SystemEventType =
|
15172
|
+
declare type SystemEventType = EventType_8;
|
15351
15173
|
|
15352
15174
|
/**
|
15353
15175
|
* @interface
|
@@ -15404,7 +15226,7 @@ declare type SystemProcessInfo = {
|
|
15404
15226
|
* Generated when system shutdown or log off.
|
15405
15227
|
* @internal
|
15406
15228
|
*/
|
15407
|
-
declare type SystemShutdownEvent =
|
15229
|
+
declare type SystemShutdownEvent = BaseEvent_8 & {
|
15408
15230
|
type: 'system-shutdown';
|
15409
15231
|
};
|
15410
15232
|
|
@@ -15465,75 +15287,11 @@ declare interface TabDragListener extends EventEmitter_2 {
|
|
15465
15287
|
contentItem: ContentItem;
|
15466
15288
|
}
|
15467
15289
|
|
15468
|
-
/**
|
15469
|
-
* @typedef {string} LayoutPosition
|
15470
|
-
* @summary Represents the position of an item in a layout relative to another. Possible values are 'top', 'bottom', 'left' and 'right'.
|
15471
|
-
*/
|
15472
|
-
/**
|
15473
|
-
* @typedef {object} StackCreationOptions
|
15474
|
-
* @summary Stack creation options.
|
15475
|
-
* @property {LayoutPosition} [position] - The position to create the new {@link TabStack} in, relative to the given adjacent {@link TabStack}. Defaults to 'right'.
|
15476
|
-
*/
|
15477
|
-
/**
|
15478
|
-
* @typedef {object} TabStack~AddViewOptions
|
15479
|
-
* @summary Options to use when adding a view to a {@link TabStack}
|
15480
|
-
* @property {number} [index] - Insertion index when adding the view. Defaults to 0.
|
15481
|
-
*/
|
15482
15290
|
/**
|
15483
15291
|
* A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
|
15484
15292
|
*/
|
15485
15293
|
declare class TabStack extends LayoutNode {
|
15486
15294
|
#private;
|
15487
|
-
/**
|
15488
|
-
* Determines if this {@link TabStack} is the top level content item in the current layout.
|
15489
|
-
* @function isRoot
|
15490
|
-
* @memberof TabStack
|
15491
|
-
* @instance
|
15492
|
-
* @tutorial TabStack.isRoot
|
15493
|
-
* @returns Resolves true if this TabStack is the top level content item, or false if it is not.
|
15494
|
-
*/
|
15495
|
-
/**
|
15496
|
-
* Determines if this {@link TabStack} exists.
|
15497
|
-
* @function exists
|
15498
|
-
* @instance
|
15499
|
-
* @memberof TabStack
|
15500
|
-
* @tutorial TabStack.exists
|
15501
|
-
* @returns Resolves true if this is the TabStack exists, or false if it has been destroyed.
|
15502
|
-
*/
|
15503
|
-
/**
|
15504
|
-
* Retrieves the parent {@link ColumnOrRow} of this {@link TabStack}, if one exists.
|
15505
|
-
* @function getParent
|
15506
|
-
* @instance
|
15507
|
-
* @memberof TabStack
|
15508
|
-
* @tutorial TabStack.getParent
|
15509
|
-
* @returns is the root content item or does not exist.
|
15510
|
-
*/
|
15511
|
-
/**
|
15512
|
-
* Returns all the adjacent stacks that share an edge with the given {@link TabStack}.
|
15513
|
-
* @function getAdjacentStacks
|
15514
|
-
* @instance
|
15515
|
-
* @memberof TabStack
|
15516
|
-
* @param {LayoutPosition} edge - Edge to check for any adjacent stacks.
|
15517
|
-
*
|
15518
|
-
* @tutorial TabStack.getAdjacentStacks
|
15519
|
-
*/
|
15520
|
-
/**
|
15521
|
-
* Given a list of view creation options or references and a layout position, creates a {@link TabStack} adjacent to the current {@link TabStack}
|
15522
|
-
*
|
15523
|
-
* Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
|
15524
|
-
* during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
|
15525
|
-
* This means the views you pass to createAdjacentStack() may not render in the order given by the array.
|
15526
|
-
* Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
|
15527
|
-
*
|
15528
|
-
* @function createAdjacentStack
|
15529
|
-
* @instance
|
15530
|
-
* @memberof TabStack
|
15531
|
-
* @param views - List of identities or view creation options of the views to include in the stack
|
15532
|
-
* @param options - Creation options.
|
15533
|
-
* @returns The created TabStack.
|
15534
|
-
* @tutorial TabStack.createAdjacentStack
|
15535
|
-
* @experimental
|
15536
|
-
*/
|
15537
15295
|
/** @internal */
|
15538
15296
|
constructor(client: LayoutEntitiesClient, entityId: string);
|
15539
15297
|
/**
|
@@ -15657,7 +15415,7 @@ declare type TargetApp = string | AppMetadata;
|
|
15657
15415
|
* In that case, previousTarget identity will be the same as target identity.
|
15658
15416
|
* @interface
|
15659
15417
|
*/
|
15660
|
-
declare type TargetChangedEvent =
|
15418
|
+
declare type TargetChangedEvent = BaseEvent_4 & {
|
15661
15419
|
type: 'target-changed';
|
15662
15420
|
previousTarget: OpenFin.Identity;
|
15663
15421
|
};
|
@@ -15811,7 +15569,7 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
|
|
15811
15569
|
* Generated when the tray icon is clicked.
|
15812
15570
|
* @interface
|
15813
15571
|
*/
|
15814
|
-
declare type TrayIconClickedEvent = IdentityEvent & {
|
15572
|
+
declare type TrayIconClickedEvent = BaseEvents.IdentityEvent & {
|
15815
15573
|
topic: 'application';
|
15816
15574
|
type: 'tray-icon-clicked';
|
15817
15575
|
button: 0 | 1 | 2;
|
@@ -15901,7 +15659,7 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
|
|
15901
15659
|
* A general user bounds change event without event type.
|
15902
15660
|
* @interface
|
15903
15661
|
*/
|
15904
|
-
declare type UserBoundsChangeEvent =
|
15662
|
+
declare type UserBoundsChangeEvent = BaseEvent_5 & {
|
15905
15663
|
height: number;
|
15906
15664
|
left: number;
|
15907
15665
|
top: number;
|
@@ -15913,7 +15671,7 @@ declare type UserBoundsChangeEvent = BaseWindowEvent & {
|
|
15913
15671
|
* Generated when a window's user movement becomes disabled.
|
15914
15672
|
* @interface
|
15915
15673
|
*/
|
15916
|
-
declare type UserMovementDisabledEvent =
|
15674
|
+
declare type UserMovementDisabledEvent = BaseEvent_5 & {
|
15917
15675
|
type: 'user-movement-disabled';
|
15918
15676
|
};
|
15919
15677
|
|
@@ -15921,7 +15679,7 @@ declare type UserMovementDisabledEvent = BaseWindowEvent & {
|
|
15921
15679
|
* Generated when a window's user movement becomes enabled.
|
15922
15680
|
* @interface
|
15923
15681
|
*/
|
15924
|
-
declare type UserMovementEnabledEvent =
|
15682
|
+
declare type UserMovementEnabledEvent = BaseEvent_5 & {
|
15925
15683
|
type: 'user-movement-enabled';
|
15926
15684
|
};
|
15927
15685
|
|
@@ -15974,169 +15732,6 @@ declare type VerboseWebPermission = {
|
|
15974
15732
|
|
15975
15733
|
declare type View = OpenFin.View;
|
15976
15734
|
|
15977
|
-
/**
|
15978
|
-
* @PORTED
|
15979
|
-
* @typedef {object} View~options
|
15980
|
-
* @summary View creation options.
|
15981
|
-
* @desc This is the options object required by {@link View.create View.create}.
|
15982
|
-
*
|
15983
|
-
* Note that `name` and `target` are the only required properties — albeit the `url` property is usually provided as well
|
15984
|
-
* (defaults to `"about:blank"` when omitted).
|
15985
|
-
*
|
15986
|
-
* @property {object} [experimental]
|
15987
|
-
* Configurations for API injection.
|
15988
|
-
*
|
15989
|
-
* @property {boolean} [experimental.childWindows] Configure if the runtime should enable child windows for views.
|
15990
|
-
*
|
15991
|
-
* @property {object} [accelerator]
|
15992
|
-
* Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
|
15993
|
-
*
|
15994
|
-
* @property {boolean} [accelerator.devtools=false]
|
15995
|
-
* If `true`, enables the devtools keyboard shortcut:<br>
|
15996
|
-
* `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
|
15997
|
-
*
|
15998
|
-
* @property {boolean} [accelerator.reload=false]
|
15999
|
-
* If `true`, enables the reload keyboard shortcuts:<br>
|
16000
|
-
* `Ctrl` + `R` _(Windows)_<br>
|
16001
|
-
* `F5` _(Windows)_<br>
|
16002
|
-
* `Command` + `R` _(Mac)_
|
16003
|
-
*
|
16004
|
-
* @property {boolean} [accelerator.reloadIgnoringCache=false]
|
16005
|
-
* If `true`, enables the reload-from-source keyboard shortcuts:<br>
|
16006
|
-
* `Ctrl` + `Shift` + `R` _(Windows)_<br>
|
16007
|
-
* `Shift` + `F5` _(Windows)_<br>
|
16008
|
-
* `Command` + `Shift` + `R` _(Mac)_
|
16009
|
-
*
|
16010
|
-
* @property {boolean} [accelerator.zoom=false]
|
16011
|
-
* If `true`, enables the zoom keyboard shortcuts:<br>
|
16012
|
-
* `Ctrl` + `+` _(Zoom In)_<br>
|
16013
|
-
* `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
|
16014
|
-
* `Ctrl` + `NumPad+` _(Zoom In)_<br>
|
16015
|
-
* `Ctrl` + `-` _(Zoom Out)_<br>
|
16016
|
-
* `Ctrl` + `Shift` + `-` _(Zoom Out)_<br>
|
16017
|
-
* `Ctrl` + `NumPad-` _(Zoom Out)_<br>
|
16018
|
-
* `Ctrl` + `Scroll` _(Zoom In & Out)_<br>
|
16019
|
-
* `Ctrl` + `0` _(Restore to 100%)_
|
16020
|
-
*
|
16021
|
-
* @property {object} [api]
|
16022
|
-
* Configurations for API injection.
|
16023
|
-
*
|
16024
|
-
* @property {object} [api.iframe] Configure if the the API should be injected into iframes based on domain.
|
16025
|
-
*
|
16026
|
-
* @property {boolean} [api.iframe.crossOriginInjection=false] Controls if the `fin` API object is present for cross origin iframes.
|
16027
|
-
* @property {boolean} [api.iframe.sameOriginInjection=true] Controls if the `fin` API object is present for same origin iframes.
|
16028
|
-
*
|
16029
|
-
* @property {string} [autoplayPolicy="no-user-gesture-required"]
|
16030
|
-
* Autoplay policy to apply to content in the window, can be
|
16031
|
-
* `no-user-gesture-required`, `user-gesture-required`,
|
16032
|
-
* `document-user-activation-required`. Defaults to `no-user-gesture-required`.
|
16033
|
-
*
|
16034
|
-
* @property {object} [autoResize] AutoResize options
|
16035
|
-
*
|
16036
|
-
* @property {object} [bounds] initial bounds given relative to the window.
|
16037
|
-
*
|
16038
|
-
* @property {string} [backgroundColor="#FFF"] - _Updatable._
|
16039
|
-
* The view’s _backfill_ color as a hexadecimal value. Not to be confused with the content background color
|
16040
|
-
* (`document.body.style.backgroundColor`),
|
16041
|
-
* this color briefly fills a view’s (a) content area before its content is loaded as well as (b) newly exposed
|
16042
|
-
* areas when growing a window. Setting
|
16043
|
-
* this value to the anticipated content background color can help improve user experience.
|
16044
|
-
* Default is white.
|
16045
|
-
*
|
16046
|
-
* @property {object} [contentNavigation]
|
16047
|
-
* Restrict navigation to URLs that match an allowed pattern.
|
16048
|
-
* In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
|
16049
|
-
* See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
|
16050
|
-
* @property {string[]} [contentNavigation.allowlist=[]] List of allowed URLs.
|
16051
|
-
* @property {string[]} [contentNavigation.denylist=[]] List of denied URLs.
|
16052
|
-
*
|
16053
|
-
* @property {object} [contentRedirect]
|
16054
|
-
* Restrict redirects to URLs that match an allowed pattern.
|
16055
|
-
* In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
|
16056
|
-
* See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
|
16057
|
-
* @property {string[]} [contentRedirect.allowlist=[]] List of allowed URLs.
|
16058
|
-
* @property {string[]} [contentRedirect.denylist=[]] List of denied URLs.
|
16059
|
-
*
|
16060
|
-
* @property {object} [contextMenuSettings] - _Updatable._
|
16061
|
-
* Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
|
16062
|
-
* Configure the context menu when right-clicking on a view.
|
16063
|
-
* @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
|
16064
|
-
* @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
|
16065
|
-
* @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
|
16066
|
-
*
|
16067
|
-
* @property {object} [contextMenuOptions] - _Updatable._
|
16068
|
-
* Configure the context menu when right-clicking on a view. Supported menu items:
|
16069
|
-
* 'separator'
|
16070
|
-
* 'cut'
|
16071
|
-
* 'copy'
|
16072
|
-
* 'copyImage',
|
16073
|
-
* 'paste'
|
16074
|
-
* 'spellCheck'
|
16075
|
-
* 'inspect'
|
16076
|
-
* 'reload'
|
16077
|
-
* 'navigateForward'
|
16078
|
-
* 'navigateBack'
|
16079
|
-
* 'print'
|
16080
|
-
* @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
|
16081
|
-
* @property {string[]} [contextMenuOptions.template=[]] List of context menu items to display on right-click.
|
16082
|
-
*
|
16083
|
-
* @property {any} [customData=""] - _Updatable._
|
16084
|
-
* A field that the user can attach serializable data to be ferried around with the view options.
|
16085
|
-
* _When omitted, the default value of this property is the empty string (`""`)._
|
16086
|
-
*
|
16087
|
-
* @property {any} [customContext=""] - _Updatable._
|
16088
|
-
* A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
|
16089
|
-
* is called.
|
16090
|
-
* When omitted, the default value of this property is the empty string (`""`).
|
16091
|
-
* As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
|
16092
|
-
*
|
16093
|
-
* @property {object[]} [hotkeys=[]] - _Updatable._
|
16094
|
-
* Defines the list of hotkeys that will be emitted as a `hotkey` event on the view. For usage example see [example]{@tutorial hotkeys}.
|
16095
|
-
* Within Platform, OpenFin also implements a set of pre-defined actions called
|
16096
|
-
* [keyboard commands]{@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands}
|
16097
|
-
* that can be assigned to a specific hotkey in the platform manifest.
|
16098
|
-
* @property {string} hotkeys.keys The key combination of the hotkey, i.e. "Ctrl+T"
|
16099
|
-
* @property {boolean} [hotkeys.preventDefault=false] preventDefault will prevent the page keydown/keyup events from being emitted.
|
16100
|
-
*
|
16101
|
-
* @property {boolean} [isClosable=true] **Platforms Only.** If false, the view will be persistent and can't be closed through
|
16102
|
-
* either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
|
16103
|
-
* if the view isn't part of the new layout when running `Layout.replace`.
|
16104
|
-
*
|
16105
|
-
* @property {string} name
|
16106
|
-
* The name of the view.
|
16107
|
-
*
|
16108
|
-
* @property {boolean} [detachOnClose=false] - _Updatable._
|
16109
|
-
* Platforms Only. If true, will hide and detach the View from the window for later use instead of closing,
|
16110
|
-
* allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
|
16111
|
-
*
|
16112
|
-
* @property {string} [manifestUrl] **Platforms Only.** Url to a manifest that contains View Options. Properties other than manifestUrl can still be used
|
16113
|
-
* but the properties in the manifest will take precedence if there is any collision.
|
16114
|
-
*
|
16115
|
-
* @property {preloadScript[]} [preloadScripts] - _Inheritable_
|
16116
|
-
* A list of scripts that are eval'ed before other scripts in the page. When omitted, _inherits_
|
16117
|
-
* from the parent application.
|
16118
|
-
*
|
16119
|
-
* @property {boolean} [preventDragOut=false] **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
|
16120
|
-
*
|
16121
|
-
* @property {string} [processAffinity=<application uuid>]
|
16122
|
-
* A string to attempt to group renderers together. Will only be used if pages are on the same origin.
|
16123
|
-
*
|
16124
|
-
* @property {boolean} [spellCheck=false]
|
16125
|
-
* Enable spell check in input text fields for the view.
|
16126
|
-
*
|
16127
|
-
* @property {Identity} [target]
|
16128
|
-
* The identity of the window this view should be attached to.
|
16129
|
-
*
|
16130
|
-
* @property {string} [url="about:blank"]
|
16131
|
-
* The URL of the view.
|
16132
|
-
*
|
16133
|
-
* @property {string} [uuid=<application uuid>]
|
16134
|
-
* The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
|
16135
|
-
* If omitted, defaults to the `uuid` of the application spawning the view.
|
16136
|
-
* If given, must match the `uuid` of the application spawning the view.
|
16137
|
-
* In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
|
16138
|
-
* really no need to provide it.
|
16139
|
-
*/
|
16140
15735
|
/**
|
16141
15736
|
* A View can be used to embed additional web content into a Window.
|
16142
15737
|
* It is like a child window, except it is positioned relative to its owning window.
|
@@ -16608,7 +16203,7 @@ declare class View_2 extends WebContents<OpenFin.ViewEvent> {
|
|
16608
16203
|
* Generated when a View is attached to a window.
|
16609
16204
|
* @interface
|
16610
16205
|
*/
|
16611
|
-
declare type ViewAttachedEvent =
|
16206
|
+
declare type ViewAttachedEvent = BaseEvent_5 & {
|
16612
16207
|
type: 'view-attached';
|
16613
16208
|
target: OpenFin.Identity;
|
16614
16209
|
viewIdentity: OpenFin.Identity;
|
@@ -16650,26 +16245,23 @@ declare type ViewCreationOrReference = OpenFin.Identity | OpenFin.PlatformViewCr
|
|
16650
16245
|
* @remarks Will fire when a view is destroyed in which case `target` will be null.
|
16651
16246
|
* @interface
|
16652
16247
|
*/
|
16653
|
-
declare type ViewDetachedEvent =
|
16248
|
+
declare type ViewDetachedEvent = BaseEvent_5 & {
|
16654
16249
|
type: 'view-detached';
|
16655
|
-
target: OpenFin.Identity;
|
16250
|
+
target: OpenFin.Identity | null;
|
16656
16251
|
previousTarget: OpenFin.Identity;
|
16657
16252
|
viewIdentity: OpenFin.Identity;
|
16658
16253
|
};
|
16659
16254
|
|
16660
16255
|
/**
|
16661
|
-
*
|
16662
|
-
* discriminated by {@link ViewEvent.type | their type}. Event payloads unique to `View` can be found
|
16663
|
-
* under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
|
16256
|
+
* @deprecated Renamed to {@link Event}.
|
16664
16257
|
*/
|
16665
|
-
declare type ViewEvent =
|
16666
|
-
target: OpenFin.Identity;
|
16667
|
-
}) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
|
16258
|
+
declare type ViewEvent = Event_4;
|
16668
16259
|
|
16669
16260
|
declare type ViewEvent_2 = Events.ViewEvents.ViewEvent;
|
16670
16261
|
|
16671
16262
|
declare namespace ViewEvents {
|
16672
16263
|
export {
|
16264
|
+
BaseEvent_4 as BaseEvent,
|
16673
16265
|
BaseViewEvent,
|
16674
16266
|
TargetChangedEvent,
|
16675
16267
|
NonPropagatedViewEvent,
|
@@ -16679,20 +16271,24 @@ declare namespace ViewEvents {
|
|
16679
16271
|
HotkeyEvent,
|
16680
16272
|
ShownEvent,
|
16681
16273
|
HostContextChangedEvent,
|
16274
|
+
Event_4 as Event,
|
16682
16275
|
ViewEvent,
|
16683
16276
|
WillPropagateViewEvent,
|
16277
|
+
EventType,
|
16684
16278
|
ViewEventType,
|
16279
|
+
PropagatedEvent_2 as PropagatedEvent,
|
16685
16280
|
PropagatedViewEvent,
|
16281
|
+
PropagatedEventType_2 as PropagatedEventType,
|
16686
16282
|
PropagatedViewEventType,
|
16687
|
-
|
16688
|
-
|
16283
|
+
Payload_2 as Payload,
|
16284
|
+
ByType
|
16689
16285
|
}
|
16690
16286
|
}
|
16691
16287
|
|
16692
16288
|
/**
|
16693
|
-
*
|
16289
|
+
* @deprecated Renamed to {@link EventType}.
|
16694
16290
|
*/
|
16695
|
-
declare type ViewEventType =
|
16291
|
+
declare type ViewEventType = EventType;
|
16696
16292
|
|
16697
16293
|
/**
|
16698
16294
|
* @interface
|
@@ -17831,12 +17427,9 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
17831
17427
|
}
|
17832
17428
|
|
17833
17429
|
/**
|
17834
|
-
*
|
17835
|
-
* (i.e. {@link OpenFin.Window} or {@link OpenFin.View}).
|
17430
|
+
* @deprecated Renamed to {@link Event}.
|
17836
17431
|
*/
|
17837
|
-
declare type WebContentsEvent<Topic extends string> =
|
17838
|
-
topic: Topic;
|
17839
|
-
} & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | FaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent);
|
17432
|
+
declare type WebContentsEvent<Topic extends string> = Event_5<Topic>;
|
17840
17433
|
|
17841
17434
|
declare type WebContentsEvent_2<Topic extends string> = Events.WebContentsEvents.WebContentsEvent<Topic>;
|
17842
17435
|
|
@@ -17848,6 +17441,7 @@ declare namespace WebContentsEvents {
|
|
17848
17441
|
CrashedEvent_2 as CrashedEvent,
|
17849
17442
|
CertificateErrorEvent,
|
17850
17443
|
CertificateSelectionShownEvent,
|
17444
|
+
PageFaviconUpdatedEvent,
|
17851
17445
|
FaviconUpdatedEvent,
|
17852
17446
|
NavigationRejectedEvent,
|
17853
17447
|
UrlChangedEvent,
|
@@ -17866,6 +17460,7 @@ declare namespace WebContentsEvents {
|
|
17866
17460
|
FileDownloadStartedEvent,
|
17867
17461
|
FileDownloadProgressEvent,
|
17868
17462
|
FileDownloadCompletedEvent,
|
17463
|
+
Event_5 as Event,
|
17869
17464
|
WebContentsEvent,
|
17870
17465
|
WillPropagateWebContentsEvent,
|
17871
17466
|
NonPropagatedWebContentsEvent
|
@@ -17888,7 +17483,7 @@ declare namespace WebContentsEvents {
|
|
17888
17483
|
* `clipboard-read`: Request access to read from the clipboard.<br>
|
17889
17484
|
* `clipboard-sanitized-write`: Request access to write to the clipboard.
|
17890
17485
|
*/
|
17891
|
-
declare type WebPermission = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write' | OpenExternalPermission;
|
17486
|
+
declare type WebPermission = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write' | 'hid' | 'usb' | OpenExternalPermission;
|
17892
17487
|
|
17893
17488
|
/**
|
17894
17489
|
* Object representing headers and their values, where the
|
@@ -17913,7 +17508,7 @@ declare type WillMoveEvent = WillMoveOrResizeEvent & {
|
|
17913
17508
|
* A general will-move or will-resize event without event type.
|
17914
17509
|
* @interface
|
17915
17510
|
*/
|
17916
|
-
declare type WillMoveOrResizeEvent =
|
17511
|
+
declare type WillMoveOrResizeEvent = BaseEvent_5 & {
|
17917
17512
|
height: number;
|
17918
17513
|
left: number;
|
17919
17514
|
top: number;
|
@@ -17935,7 +17530,7 @@ declare type WillPropagateViewEvent = ViewEvent;
|
|
17935
17530
|
*
|
17936
17531
|
* A WebContents event that does propagate to (republish on) parent topics.
|
17937
17532
|
*/
|
17938
|
-
declare type WillPropagateWebContentsEvent =
|
17533
|
+
declare type WillPropagateWebContentsEvent = Event_5<string>;
|
17939
17534
|
|
17940
17535
|
/**
|
17941
17536
|
* @DEPRECATED all Window events propagate, so this is redundant - left as a convenience shim to avoid breaking
|
@@ -17949,7 +17544,7 @@ declare type WillPropagateWindowEvent = WindowSourcedEvent;
|
|
17949
17544
|
* Generated when window is being redirected as per contentRedirect allowlist/denylist rules.
|
17950
17545
|
* @interface
|
17951
17546
|
*/
|
17952
|
-
declare type WillRedirectEvent =
|
17547
|
+
declare type WillRedirectEvent = BaseEvent_5 & {
|
17953
17548
|
type: 'will-redirect';
|
17954
17549
|
blocked: boolean;
|
17955
17550
|
isInPlace: boolean;
|
@@ -17966,476 +17561,6 @@ declare type WillResizeEvent = WillMoveOrResizeEvent & {
|
|
17966
17561
|
type: 'will-resize';
|
17967
17562
|
};
|
17968
17563
|
|
17969
|
-
/**
|
17970
|
-
* @PORTED
|
17971
|
-
* @typedef { object } Margins@typedef { object } Margins
|
17972
|
-
* @property { string } [marginType]
|
17973
|
-
* Can be `default`, `none`, `printableArea`, or `custom`. If `custom` is chosen,
|
17974
|
-
* you will also need to specify `top`, `bottom`, `left`, and `right`.
|
17975
|
-
*
|
17976
|
-
* @property { number } [top] The top margin of the printed web page, in pixels.
|
17977
|
-
* @property { number } [bottom] The bottom margin of the printed web page, in pixels.
|
17978
|
-
* @property { number } [left] The left margin of the printed web page, in pixels.
|
17979
|
-
* @property { number } [right] The right margin of the printed web page, in pixels.
|
17980
|
-
*/
|
17981
|
-
/**
|
17982
|
-
* @PORTED
|
17983
|
-
* @typedef { object } Dpi@typedef { object } Dpi
|
17984
|
-
* @property { number } [horizontal] The horizontal dpi
|
17985
|
-
* @property { number } [vertical] The vertical dpi
|
17986
|
-
*/
|
17987
|
-
/**
|
17988
|
-
* @PORTED
|
17989
|
-
* @typedef { object } PrintOptions@typedef { object } PrintOptions
|
17990
|
-
* @property { boolean } [silent=false] Don't ask user for print settings.
|
17991
|
-
* @property { boolean } [printBackground=false] Prints the background color and image of the web page.
|
17992
|
-
* @property { string } [deviceName=''] Set the printer device name to use.
|
17993
|
-
* @property { boolean } [color=true] Set whether the printed web page will be in color or grayscale.
|
17994
|
-
* @property { Margins } [margins] Set margins for the printed web page
|
17995
|
-
* @property { boolean } [landscape=false] Whether the web page should be printed in landscape mode.
|
17996
|
-
* @property { number } [scaleFactor] The scale factor of the web page.
|
17997
|
-
* @property { number } [pagesPerSheet] The number of pages to print per page sheet.
|
17998
|
-
* @property { boolean } [collate] Whether the web page should be collated.
|
17999
|
-
* @property { number } [copies] The number of copies of the web page to print.
|
18000
|
-
* @property { Record<string, number> } [pageRanges] The page range to print. Should have two keys: from and to.
|
18001
|
-
* @property { string } [duplexMode] Set the duplex mode of the printed web page. Can be simplex, shortEdge, or longEdge.
|
18002
|
-
* @property { Dpi } [dpi] Set dpi for the printed web page
|
18003
|
-
*/
|
18004
|
-
/**
|
18005
|
-
* @REMOVED
|
18006
|
-
* PrinterInfo interface
|
18007
|
-
* @typedef { object } PrinterInfo@typedef { object } PrinterInfo
|
18008
|
-
* @property { string } name Printer Name
|
18009
|
-
* @property { string } description Printer Description
|
18010
|
-
* @property { number } status Printer Status
|
18011
|
-
* @property { boolean } isDefault Indicates that system's default printer
|
18012
|
-
*/
|
18013
|
-
/**
|
18014
|
-
* @REMOVED
|
18015
|
-
* SharedWorkerInfo interface
|
18016
|
-
* @typedef { object } SharedWorkerInfo@typedef { object } SharedWorkerInfo
|
18017
|
-
* @property { string } id The unique id of the shared worker.
|
18018
|
-
* @property { string } url The url of the shared worker.
|
18019
|
-
*/
|
18020
|
-
/**
|
18021
|
-
* @PORTED
|
18022
|
-
* ContentCreationRule interface
|
18023
|
-
* @typedef { object } ContentCreationRule@typedef { object } ContentCreationRule
|
18024
|
-
* @property { string } behavior 'view' | 'window' | 'browser' | 'block'
|
18025
|
-
* @property { string[] } match List of [match patterns](https://developer.chrome.com/extensions/match_patterns).
|
18026
|
-
* @property { object } options Window creation options or View creation options.
|
18027
|
-
*/
|
18028
|
-
/**
|
18029
|
-
* @PORTED
|
18030
|
-
* @typedef {object} Window~options
|
18031
|
-
* @summary Window creation options.
|
18032
|
-
* @desc This is the options object required by {@link Window.create Window.create}.
|
18033
|
-
*
|
18034
|
-
* Note that `name` is the only required property — albeit the `url` property is usually provided as well
|
18035
|
-
* (defaults to `"about:blank"` when omitted).
|
18036
|
-
*
|
18037
|
-
* _This jsdoc typedef mirrors the `WindowOptions` TypeScript interface in `@types/openfin`._
|
18038
|
-
*
|
18039
|
-
* @property {object} [accelerator]
|
18040
|
-
* Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
|
18041
|
-
*
|
18042
|
-
* @property {boolean} [accelerator.devtools=false]
|
18043
|
-
* If `true`, enables the devtools keyboard shortcut:<br>
|
18044
|
-
* `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
|
18045
|
-
*
|
18046
|
-
* @property {boolean} [accelerator.reload=false]
|
18047
|
-
* If `true`, enables the reload keyboard shortcuts:<br>
|
18048
|
-
* `Ctrl` + `R` _(Windows)_<br>
|
18049
|
-
* `F5` _(Windows)_<br>
|
18050
|
-
* `Command` + `R` _(Mac)_
|
18051
|
-
*
|
18052
|
-
* @property {boolean} [accelerator.reloadIgnoringCache=false]
|
18053
|
-
* If `true`, enables the reload-from-source keyboard shortcuts:<br>
|
18054
|
-
* `Ctrl` + `Shift` + `R` _(Windows)_<br>
|
18055
|
-
* `Shift` + `F5` _(Windows)_<br>
|
18056
|
-
* `Command` + `Shift` + `R` _(Mac)_
|
18057
|
-
*
|
18058
|
-
* @property {boolean} [accelerator.zoom=false]
|
18059
|
-
* 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.
|
18060
|
-
* If `true`, enables the zoom keyboard shortcuts:<br>
|
18061
|
-
* `Ctrl` + `+` _(Zoom In)_<br>
|
18062
|
-
* `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
|
18063
|
-
* `Ctrl` + `NumPad+` _(Zoom In)_<br>
|
18064
|
-
* `Ctrl` + `-` _(Zoom Out)_<br>
|
18065
|
-
* `Ctrl` + `Shift` + `-` _(Zoom Out)_<br>
|
18066
|
-
* `Ctrl` + `NumPad-` _(Zoom Out)_<br>
|
18067
|
-
* `Ctrl` + `Scroll` _(Zoom In & Out)_<br>
|
18068
|
-
* `Ctrl` + `0` _(Restore to 100%)_
|
18069
|
-
*
|
18070
|
-
* @property {object} [alphaMask] - _Experimental._ _Updatable._
|
18071
|
-
* <br>
|
18072
|
-
* alphaMask turns anything of matching RGB value transparent.
|
18073
|
-
* <br>
|
18074
|
-
* Caveats:
|
18075
|
-
* * Runtime flags --disable-gpu and --allow-unsafe-compositing are required. Note: Unclear behavior on remote Desktop support
|
18076
|
-
* * User cannot click-through transparent regions
|
18077
|
-
* * Not supported on Mac
|
18078
|
-
* * Windows Aero must be enabled
|
18079
|
-
* * Won't make visual sense on Pixel-pushed environments such as Citrix
|
18080
|
-
* * Not supported on rounded corner windows
|
18081
|
-
* @property {number} [alphaMask.red=-1] 0-255
|
18082
|
-
* @property {number} [alphaMask.green=-1] 0-255
|
18083
|
-
* @property {number} [alphaMask.blue=-1] 0-255
|
18084
|
-
*
|
18085
|
-
* @property {boolean} [alwaysOnTop=false] - _Updatable._
|
18086
|
-
* A flag to always position the window at the top of the window stack.
|
18087
|
-
*
|
18088
|
-
* @property {object} [api]
|
18089
|
-
* Configurations for API injection.
|
18090
|
-
*
|
18091
|
-
* @property {object} [api.iframe] Configure if the the API should be injected into iframes based on domain.
|
18092
|
-
*
|
18093
|
-
* @property {boolean} [api.iframe.crossOriginInjection=false] Controls if the `fin` API object is present for cross origin iframes.
|
18094
|
-
* @property {boolean} [api.iframe.sameOriginInjection=true] Controls if the `fin` API object is present for same origin iframes.
|
18095
|
-
*
|
18096
|
-
* @property {string} [applicationIcon = ""] - _Deprecated_ - use `icon` instead.
|
18097
|
-
*
|
18098
|
-
* @property {number} [aspectRatio=0] - _Updatable._
|
18099
|
-
* The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
|
18100
|
-
* an aspect ratio will not be enforced.
|
18101
|
-
*
|
18102
|
-
* @property {string} [autoplayPolicy="no-user-gesture-required"]
|
18103
|
-
* Autoplay policy to apply to content in the window, can be
|
18104
|
-
* `no-user-gesture-required`, `user-gesture-required`,
|
18105
|
-
* `document-user-activation-required`. Defaults to `no-user-gesture-required`.
|
18106
|
-
*
|
18107
|
-
* @property {boolean} [autoShow=true]
|
18108
|
-
* A flag to automatically show the window when it is created.
|
18109
|
-
*
|
18110
|
-
* @property {string} [backgroundColor="#FFF"]
|
18111
|
-
* The window’s _backfill_ color as a hexadecimal value. Not to be confused with the content background color
|
18112
|
-
* (`document.body.style.backgroundColor`),
|
18113
|
-
* this color briefly fills a window’s (a) content area before its content is loaded as well as (b) newly exposed
|
18114
|
-
* areas when growing a window. Setting
|
18115
|
-
* this value to the anticipated content background color can help improve user experience.
|
18116
|
-
* Default is white.
|
18117
|
-
*
|
18118
|
-
* @property {object} [contentCreation]
|
18119
|
-
* Apply rules that determine how user interaction (`window.open` and links) creates content.
|
18120
|
-
* @property {ContentCreationRule[]} [contentCreation.rules = []] List of content creation rules.
|
18121
|
-
*
|
18122
|
-
* @property {object} [contentNavigation]
|
18123
|
-
* Restrict navigation to URLs that match an allowed pattern.
|
18124
|
-
* In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
|
18125
|
-
* See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
|
18126
|
-
* @property {string[]} [contentNavigation.allowlist=[]] List of allowed URLs.
|
18127
|
-
* @property {string[]} [contentNavigation.denylist=[]] List of denied URLs.
|
18128
|
-
*
|
18129
|
-
* @property {object} [contentRedirect]
|
18130
|
-
* Restrict redirects to URLs that match an allowed pattern.
|
18131
|
-
* In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
|
18132
|
-
* See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
|
18133
|
-
* @property {string[]} [contentRedirect.allowlist=[]] List of allowed URLs.
|
18134
|
-
* @property {string[]} [contentRedirect.denylist=[]] List of denied URLs.
|
18135
|
-
*
|
18136
|
-
* @property {boolean} [contextMenu=true] - _Updatable._
|
18137
|
-
* A flag to show the context menu when right-clicking on a window.
|
18138
|
-
* Gives access to the devtools for the window.
|
18139
|
-
*
|
18140
|
-
* @property {object} [contextMenuSettings] - _Updatable._
|
18141
|
-
* Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
|
18142
|
-
* Configure the context menu when right-clicking on a window.
|
18143
|
-
* @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
|
18144
|
-
* @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
|
18145
|
-
* @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
|
18146
|
-
*
|
18147
|
-
* @property {object} [contextMenuOptions] - _Updatable._
|
18148
|
-
* Configure the context menu when right-clicking on a window. Supported menu items:
|
18149
|
-
* 'separator'
|
18150
|
-
* 'cut'
|
18151
|
-
* 'copy'
|
18152
|
-
* 'paste'
|
18153
|
-
* 'spellCheck'
|
18154
|
-
* 'inspect'
|
18155
|
-
* 'reload'
|
18156
|
-
* 'navigateForward'
|
18157
|
-
* 'navigateBack'
|
18158
|
-
* 'print'
|
18159
|
-
* @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
|
18160
|
-
* @property {string[]} [contextMenuSettings.template=[]] List of context menu items to display on right-click.
|
18161
|
-
*
|
18162
|
-
* @property {object} [cornerRounding] - _Updatable._
|
18163
|
-
* Defines and applies rounded corners for a frameless window. **NOTE:** On macOS corner is not ellipse but circle rounded by the
|
18164
|
-
* average of _height_ and _width_.
|
18165
|
-
* @property {number} [cornerRounding.height=0] The height in pixels.
|
18166
|
-
* @property {number} [cornerRounding.width=0] The width in pixels.
|
18167
|
-
*
|
18168
|
-
* @property {any} [customContext=""] - _Updatable. Inheritable._
|
18169
|
-
* A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
|
18170
|
-
* is called. If a window in a Platform is trying to update or retrieve its own context, it can use the
|
18171
|
-
* {@link Platform#setWindowContext Platform.setWindowContext} and {@link Platform#getWindowContext Platform.getWindowContext} calls.
|
18172
|
-
* _When omitted, _inherits_ from the parent application._
|
18173
|
-
* As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
|
18174
|
-
*
|
18175
|
-
* @property {any} [customData=""] - _Updatable. Inheritable._
|
18176
|
-
* A field that the user can attach serializable data to be ferried around with the window options.
|
18177
|
-
* _When omitted, _inherits_ from the parent application._
|
18178
|
-
*
|
18179
|
-
* @property {object[]} [customRequestHeaders]
|
18180
|
-
* Defines list of custom headers for requests sent by the window.
|
18181
|
-
* @property {string[]} [customRequestHeaders.urlPatterns=[]] The URL patterns for which the headers will be applied
|
18182
|
-
* @property {object[]} [customRequestHeaders.headers=[]] Objects representing headers and their values,
|
18183
|
-
* where the object key is the name of header and value at key is the value of the header
|
18184
|
-
*
|
18185
|
-
* @property {boolean} [closeOnLastViewRemoved=true] - _Experimental._ _Updatable._
|
18186
|
-
* Toggling off would keep the Window alive even if all its Views were closed.
|
18187
|
-
* This is meant for advanced users and should be used with caution.
|
18188
|
-
* Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
|
18189
|
-
* Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
|
18190
|
-
* ** note ** - This option is ignored in non-Platforms apps.
|
18191
|
-
*
|
18192
|
-
* @property {boolean} [defaultCentered=false]
|
18193
|
-
* Centers the window in the primary monitor. This option overrides `defaultLeft` and `defaultTop`. When `saveWindowState` is `true`,
|
18194
|
-
* this value will be ignored for subsequent launches in favor of the cached value. **NOTE:** On macOS _defaultCenter_ is
|
18195
|
-
* somewhat above center vertically.
|
18196
|
-
*
|
18197
|
-
* @property {number} [defaultHeight=500]
|
18198
|
-
* The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
|
18199
|
-
* in favor of the cached value.
|
18200
|
-
*
|
18201
|
-
* @property {number} [defaultLeft=100]
|
18202
|
-
* The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
18203
|
-
* launches in favor of the cached value.
|
18204
|
-
*
|
18205
|
-
* @property {number} [defaultTop=100]
|
18206
|
-
* The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
18207
|
-
* launches in favor of the cached value.
|
18208
|
-
*
|
18209
|
-
* @property {number} [defaultWidth=800]
|
18210
|
-
* The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
18211
|
-
* launches in favor of the cached value.
|
18212
|
-
*
|
18213
|
-
* @property {boolean} [includeInSnapshots=true] - _Updatable._
|
18214
|
-
* When true, the window will be be included in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
|
18215
|
-
* inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
|
18216
|
-
*
|
18217
|
-
* @property {boolean} [frame=true] - _Updatable._
|
18218
|
-
* A flag to show the frame.
|
18219
|
-
*
|
18220
|
-
* @hidden-property {boolean} [hideOnClose=false] - A flag to allow a window to be hidden when the close button is clicked.
|
18221
|
-
*
|
18222
|
-
* @property {object[]} [hotkeys=[]] - _Updatable._
|
18223
|
-
* Defines the list of hotkeys that will be emitted as a `hotkey` event on the window. For usage example see [example]{@tutorial hotkeys}.
|
18224
|
-
* Within Platform, OpenFin also implements a set of pre-defined actions called
|
18225
|
-
* [keyboard commands]{@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands}
|
18226
|
-
* that can be assigned to a specific hotkey in the platform manifest.
|
18227
|
-
* @property {string} hotkeys.keys The key combination of the hotkey, i.e. "Ctrl+T"
|
18228
|
-
* @property {boolean} [hotkeys.preventDefault=false] Whether or not to prevent default key handling before emitting the event
|
18229
|
-
*
|
18230
|
-
* @property {string} [icon] - _Updatable. Inheritable._
|
18231
|
-
* A URL for the icon to be shown in the window title bar and the taskbar.
|
18232
|
-
* When omitted, inherits from the parent application._
|
18233
|
-
* note: Window OS caches taskbar icons, therefore an icon change might only be visible after the cache is removed or the uuid is changed.
|
18234
|
-
*
|
18235
|
-
* @property {number} [maxHeight=-1] - _Updatable._
|
18236
|
-
* The maximum height of a window. Will default to the OS defined value if set to -1.
|
18237
|
-
*
|
18238
|
-
* @property {boolean} [maximizable=true] - _Updatable._
|
18239
|
-
* A flag that lets the window be maximized.
|
18240
|
-
*
|
18241
|
-
* @property {number} [maxWidth=-1] - _Updatable._
|
18242
|
-
* The maximum width of a window. Will default to the OS defined value if set to -1.
|
18243
|
-
*
|
18244
|
-
* @property {number} [minHeight=0] - _Updatable._
|
18245
|
-
* The minimum height of a window.
|
18246
|
-
*
|
18247
|
-
* @property {boolean} [minimizable=true] - _Updatable._
|
18248
|
-
* A flag that lets the window be minimized.
|
18249
|
-
*
|
18250
|
-
* @property {number} [minWidth=0] - _Updatable._
|
18251
|
-
* The minimum width of a window.
|
18252
|
-
*
|
18253
|
-
* @property {Identity} [modalParentIdentity]
|
18254
|
-
* Parent identity of a modal window. It will create a modal child window when this option is set.
|
18255
|
-
*
|
18256
|
-
* @property {string} name
|
18257
|
-
* The name of the window.
|
18258
|
-
*
|
18259
|
-
* @property {number} [opacity=1.0] - _Updatable._
|
18260
|
-
* A flag that specifies how transparent the window will be.
|
18261
|
-
* Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
|
18262
|
-
* This value is clamped between `0.0` and `1.0`.
|
18263
|
-
* * In software composition mode, the runtime flag --allow-unsafe-compositing is required.
|
18264
|
-
*
|
18265
|
-
* @property {preloadScript[]} [preloadScripts] - _Inheritable_
|
18266
|
-
* A list of scripts that are eval'ed before other scripts in the page. When omitted, _inherits_
|
18267
|
-
* from the parent application.
|
18268
|
-
*
|
18269
|
-
* @property {string} [processAffinity]
|
18270
|
-
* A string to attempt to group renderers together. Will only be used if pages are on the same origin.
|
18271
|
-
*
|
18272
|
-
* @property {boolean} [resizable=true] - _Updatable._
|
18273
|
-
* A flag to allow the user to resize the window.
|
18274
|
-
*
|
18275
|
-
* @property {object} [resizeRegion] - _Updatable._
|
18276
|
-
* Defines a region in pixels that will respond to user mouse interaction for resizing a frameless window.
|
18277
|
-
* @property {number} [resizeRegion.bottomRightCorner=9]
|
18278
|
-
* The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
|
18279
|
-
* @property {number} [resizeRegion.size=7]
|
18280
|
-
* The size in pixels.
|
18281
|
-
* @property {object} [resizeRegion.sides={top:true,right:true,bottom:true,left:true}]
|
18282
|
-
* Sides that a window can be resized from.
|
18283
|
-
*
|
18284
|
-
* @property {boolean} [saveWindowState=true]
|
18285
|
-
* A flag to cache the location of the window.
|
18286
|
-
* ** note ** - This option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
|
18287
|
-
*
|
18288
|
-
* @property {boolean} [ignoreSavedWindowState]
|
18289
|
-
* A flag to ignore previously cached state of the window. It defaults the opposite value of `saveWindowState` to maintain backwards compatibility.
|
18290
|
-
*
|
18291
|
-
* @property {boolean} [shadow=false]
|
18292
|
-
* A flag to display a shadow on frameless windows.
|
18293
|
-
* `shadow` and `cornerRounding` are mutually exclusive.
|
18294
|
-
* On Windows 7, Aero theme is required.
|
18295
|
-
*
|
18296
|
-
* @property {boolean} [showBackgroundImages=false] - _Updatable._
|
18297
|
-
* Platforms Only. If true, will show background images in the layout when the Views are hidden.
|
18298
|
-
* This occurs when the window is resizing or a tab is being dragged within the layout.
|
18299
|
-
*
|
18300
|
-
* @property {boolean} [showTaskbarIcon=true] - _Updatable._ _Windows_.
|
18301
|
-
* A flag to show the window's icon in the taskbar.
|
18302
|
-
*
|
18303
|
-
* @property {boolean} [smallWindow=false]
|
18304
|
-
* A flag to specify a frameless window that can be be created and resized to less than 41x36 px (width x height).
|
18305
|
-
* _Note: Caveats of small windows are no Aero Snap and drag to/from maximize._
|
18306
|
-
* _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
|
18307
|
-
*
|
18308
|
-
* @property {boolean} [spellCheck=false]
|
18309
|
-
* Enable spell check in input text fields for the window.
|
18310
|
-
*
|
18311
|
-
* @property {string} [state="normal"]
|
18312
|
-
* The visible state of the window on creation.
|
18313
|
-
* One of:
|
18314
|
-
* * `"maximized"`
|
18315
|
-
* * `"minimized"`
|
18316
|
-
* * `"normal"`
|
18317
|
-
*
|
18318
|
-
* @property {string} [taskbarIcon=string] - Deprecated - use `icon` instead._Windows_.
|
18319
|
-
*
|
18320
|
-
* @property {string} [taskbarIconGroup=<application uuid>] - _Windows_.
|
18321
|
-
* Specify a taskbar group for the window.
|
18322
|
-
* _If omitted, defaults to app's uuid (`fin.Application.getCurrentSync().identity.uuid`)._
|
18323
|
-
*
|
18324
|
-
* @property {string} [url="about:blank"]
|
18325
|
-
* The URL of the window.
|
18326
|
-
*
|
18327
|
-
* @property {string} [uuid=<application uuid>]
|
18328
|
-
* The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
|
18329
|
-
* If omitted, defaults to the `uuid` of the application spawning the window.
|
18330
|
-
* If given, must match the `uuid` of the application spawning the window.
|
18331
|
-
* In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
|
18332
|
-
* really no need to provide it.
|
18333
|
-
*
|
18334
|
-
* @property {boolean} [waitForPageLoad=false]
|
18335
|
-
* When set to `true`, the window will not appear until the `window` object's `load` event fires.
|
18336
|
-
* When set to `false`, the window will appear immediately without waiting for content to be loaded.
|
18337
|
-
*
|
18338
|
-
* @property {ViewVisibility} [viewVisibility]
|
18339
|
-
* _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
|
18340
|
-
*/
|
18341
|
-
/**
|
18342
|
-
* @PORTED
|
18343
|
-
* @typedef {Object} ViewVisibility@typedef {Object} ViewVisibility _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
|
18344
|
-
* @property {ShowViewsOnWindowResize} [showViewsOnWindowResize] Enables views to be shown when a Platform Window is being resized by the user.
|
18345
|
-
* @property {ShowViewsOnSplitterDrag} [showViewsOnSplitterDrag] Allows views to be shown when they are resized by the user dragging the splitter between layout stacks.
|
18346
|
-
* @property {ShowViewsOnTabDrag} [showViewsOnTabDrag] _Supported on Windows Operating Systems only_. Allows views to be shown when the user is dragging a tab around a layout.
|
18347
|
-
*/
|
18348
|
-
/**
|
18349
|
-
* @PORTED
|
18350
|
-
* @typedef {Object} ShowViewsOnWindowResize@typedef {Object} ShowViewsOnWindowResize _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
|
18351
|
-
* @property {boolean} [enabled=false] Enables or disables showing Views when a Platform Window is being resized.
|
18352
|
-
* @property {number} [paintIntervalMs=0] Number of miliseconds to wait between view repaints.
|
18353
|
-
*/
|
18354
|
-
/**
|
18355
|
-
* @REMOVED
|
18356
|
-
* @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.
|
18357
|
-
* @property {boolean} [enabled=false] Enables or disables showing views when the layout splitter is being dragged.
|
18358
|
-
*/
|
18359
|
-
/**
|
18360
|
-
* @REMOVED
|
18361
|
-
* @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.
|
18362
|
-
* @property {boolean} [enabled=false] Enables or disables showing views when a tab is being dragged.
|
18363
|
-
*/
|
18364
|
-
/**
|
18365
|
-
* @PORTED
|
18366
|
-
* @typedef {object} CapturePageOptions@typedef {object} CapturePageOptions
|
18367
|
-
* @property { Area } [area] The area of the window to be captured.
|
18368
|
-
* @property { string } [format='png'] The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
|
18369
|
-
* @property { number } [quality=100] Number representing quality of JPEG image only. Between 0 - 100.
|
18370
|
-
*/
|
18371
|
-
/**
|
18372
|
-
* @PORTED
|
18373
|
-
* @typedef { object } Area@typedef { object } Area
|
18374
|
-
* @property { number } height Area's height
|
18375
|
-
* @property { number } width Area's width
|
18376
|
-
* @property { number } x X coordinate of area's starting point
|
18377
|
-
* @property { number } y Y coordinate of area's starting point
|
18378
|
-
*/
|
18379
|
-
/**
|
18380
|
-
* @PORTED
|
18381
|
-
* @typedef {object} FindInPageOptions@typedef {object} FindInPageOptions
|
18382
|
-
* @property {boolean} [forward=true] Whether to search forward or backward.
|
18383
|
-
* @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.
|
18384
|
-
* @property {boolean} [matchCase=false] Whether search should be case-sensitive.
|
18385
|
-
* @property {boolean} [wordStart=false] Whether to look only at the start of words.
|
18386
|
-
* @property {boolean} [medialCapitalAsWordStart=false]
|
18387
|
-
* 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>
|
18388
|
-
* lowercase or non-letter. Accepts several other intra-word matches.
|
18389
|
-
*/
|
18390
|
-
/**
|
18391
|
-
* @REMOVED
|
18392
|
-
* @typedef {object} Transition@typedef {object} Transition
|
18393
|
-
* @property {Opacity} opacity - The Opacity transition
|
18394
|
-
* @property {Position} position - The Position transition
|
18395
|
-
* @property {Size} size - The Size transition
|
18396
|
-
*/
|
18397
|
-
/**
|
18398
|
-
* @PORTED
|
18399
|
-
* @typedef {object} TransitionOptions@typedef {object} TransitionOptions
|
18400
|
-
* @property {boolean} interrupt - This option interrupts the current animation. When false it pushes
|
18401
|
-
this animation onto the end of the animation queue.
|
18402
|
-
* @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
|
18403
|
-
*/
|
18404
|
-
/**
|
18405
|
-
* @PORTED
|
18406
|
-
* @typedef {object} Size@typedef {object} Size
|
18407
|
-
* @property {number} duration - The total time in milliseconds this transition should take.
|
18408
|
-
* @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
|
18409
|
-
* @property {number} width - Optional if height is present. Defaults to the window's current width.
|
18410
|
-
* @property {number} height - Optional if width is present. Defaults to the window's current height.
|
18411
|
-
*/
|
18412
|
-
/**
|
18413
|
-
* @PORTED
|
18414
|
-
* @typedef {object} Position@typedef {object} Position
|
18415
|
-
* @property {number} duration - The total time in milliseconds this transition should take.
|
18416
|
-
* @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
|
18417
|
-
* @property {number} left - Defaults to the window's current left position in virtual screen coordinates.
|
18418
|
-
* @property {number} top - Defaults to the window's current top position in virtual screen coordinates.
|
18419
|
-
*/
|
18420
|
-
/**
|
18421
|
-
* @PORTED
|
18422
|
-
* @typedef {object} Opacity@typedef {object} Opacity
|
18423
|
-
* @property {number} duration - The total time in milliseconds this transition should take.
|
18424
|
-
* @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
|
18425
|
-
* @property {number} opacity - This value is clamped from 0.0 to 1.0.
|
18426
|
-
*/
|
18427
|
-
/**
|
18428
|
-
* @REMOVED
|
18429
|
-
* Bounds is a interface that has the properties of height,
|
18430
|
-
* width, left, top which are all numbers
|
18431
|
-
* @typedef { object } Bounds@typedef { object } Bounds
|
18432
|
-
* @property { number } height Get the application height bound
|
18433
|
-
* @property { number } width Get the application width bound
|
18434
|
-
* @property { number } top Get the application top bound
|
18435
|
-
* @property { number } left Get the application left bound
|
18436
|
-
* @property { number } right Get the application right bound
|
18437
|
-
* @property { number } bottom Get the application bottom bound
|
18438
|
-
*/
|
18439
17564
|
/**
|
18440
17565
|
* A basic window that wraps a native HTML window. Provides more fine-grained
|
18441
17566
|
* control over the window state such as the ability to minimize, maximize, restore, etc.
|
@@ -18448,83 +17573,6 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
18448
17573
|
* @internal
|
18449
17574
|
*/
|
18450
17575
|
constructor(wire: Transport, identity: OpenFin.Identity);
|
18451
|
-
/**
|
18452
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
18453
|
-
* @param eventType - The type of the event.
|
18454
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
18455
|
-
* @param options - Option to support event timestamps.
|
18456
|
-
*
|
18457
|
-
* @function addListener
|
18458
|
-
* @memberof Window
|
18459
|
-
* @instance
|
18460
|
-
* @tutorial Window.EventEmitter
|
18461
|
-
*/
|
18462
|
-
/**
|
18463
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
18464
|
-
* @param eventType - The type of the event.
|
18465
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
18466
|
-
* @param options - Option to support event timestamps.
|
18467
|
-
*
|
18468
|
-
* @function on
|
18469
|
-
* @memberof Window
|
18470
|
-
* @instance
|
18471
|
-
* @tutorial Window.EventEmitter
|
18472
|
-
*/
|
18473
|
-
/**
|
18474
|
-
* 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.
|
18475
|
-
* @param eventType - The type of the event.
|
18476
|
-
* @param listener - The callback function.
|
18477
|
-
* @param options - Option to support event timestamps.
|
18478
|
-
*
|
18479
|
-
* @function once
|
18480
|
-
* @memberof Window
|
18481
|
-
* @instance
|
18482
|
-
* @tutorial Window.EventEmitter
|
18483
|
-
*/
|
18484
|
-
/**
|
18485
|
-
* Adds a listener to the beginning of the listeners array for the specified event.
|
18486
|
-
* @param eventType - The type of the event.
|
18487
|
-
* @param listener - The callback function.
|
18488
|
-
* @param options - Option to support event timestamps.
|
18489
|
-
*
|
18490
|
-
* @function prependListener
|
18491
|
-
* @memberof Window
|
18492
|
-
* @instance
|
18493
|
-
* @tutorial Window.EventEmitter
|
18494
|
-
*/
|
18495
|
-
/**
|
18496
|
-
* 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.
|
18497
|
-
* The listener is added to the beginning of the listeners array.
|
18498
|
-
* @param eventType - The type of the event.
|
18499
|
-
* @param listener - The callback function.
|
18500
|
-
* @param options - Option to support event timestamps.
|
18501
|
-
*
|
18502
|
-
* @function prependOnceListener
|
18503
|
-
* @memberof Window
|
18504
|
-
* @instance
|
18505
|
-
* @tutorial Window.EventEmitter
|
18506
|
-
*/
|
18507
|
-
/**
|
18508
|
-
* Remove a listener from the listener array for the specified event.
|
18509
|
-
* Caution: Calling this method changes the array indices in the listener array behind the listener.
|
18510
|
-
* @param eventType - The type of the event.
|
18511
|
-
* @param listener - The callback function.
|
18512
|
-
* @param options - Option to support event timestamps.
|
18513
|
-
*
|
18514
|
-
* @function removeListener
|
18515
|
-
* @memberof Window
|
18516
|
-
* @instance
|
18517
|
-
* @tutorial Window.EventEmitter
|
18518
|
-
*/
|
18519
|
-
/**
|
18520
|
-
* Removes all listeners, or those of the specified event.
|
18521
|
-
* @param eventType - The type of the event.
|
18522
|
-
*
|
18523
|
-
* @function removeAllListeners
|
18524
|
-
* @memberof Window
|
18525
|
-
* @instance
|
18526
|
-
* @tutorial Window.EventEmitter
|
18527
|
-
*/
|
18528
17576
|
/**
|
18529
17577
|
* create a new window
|
18530
17578
|
* @internal
|
@@ -19305,10 +18353,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19305
18353
|
show(force?: boolean): Promise<void>;
|
19306
18354
|
/**
|
19307
18355
|
* Shows the window if it is hidden at the specified location.
|
19308
|
-
*
|
19309
|
-
*
|
19310
|
-
* @param
|
19311
|
-
* @param top The right position of the window
|
18356
|
+
*
|
18357
|
+
* @param left The left position of the window in pixels
|
18358
|
+
* @param top The top position of the window in pixels
|
19312
18359
|
* @param force Show will be prevented from closing when force is false and
|
19313
18360
|
* ‘show-requested’ has been subscribed to for application’s main window
|
19314
18361
|
*
|
@@ -19370,28 +18417,6 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19370
18417
|
* ```
|
19371
18418
|
*/
|
19372
18419
|
authenticate(userName: string, password: string): Promise<void>;
|
19373
|
-
/**
|
19374
|
-
* @typedef {object} ShowPopupMenuOptions@typedef {object} ShowPopupMenuOptions
|
19375
|
-
* @property {Array<MenuItemTemplate>} template - An array describing the menu to show.
|
19376
|
-
* @property {number} [x] - The window x coordinate where to show the menu. Defaults to mouse position. If using must also use `y`.
|
19377
|
-
* @property {number} [y] - The window y coordinate where to show the menu. Defaults to mouse position. If using must also use `x`
|
19378
|
-
*/
|
19379
|
-
/**
|
19380
|
-
* @typedef {object} MenuItemTemplate@typedef {object} MenuItemTemplate
|
19381
|
-
* @property {*} data - Data to be returned if the user selects the element. Must be serializable. Large objects can have a performance impact.
|
19382
|
-
* @property {'normal' | 'separator' | 'submenu' | 'checkbox'} [type] - Defaults to 'normal' unless a 'submenu' key exists
|
19383
|
-
* @property {string} [label] - The text to show on the menu item. Should be left undefined for `type: 'separator'`
|
19384
|
-
* @property {boolean} [enabled] - If false, the menu item will be greyed out and unclickable.
|
19385
|
-
* @property {boolean} [visible] - If false, the menu item will be entirely hidden.
|
19386
|
-
* @property {boolean} [checked] - Should only be specified for `checkbox` type menu items.
|
19387
|
-
* @property {string} [icon] - Image Data URI with image dimensions inferred from the encoded string
|
19388
|
-
* @property {Array<MenuItemTemplate>} [submenu] Should be specified for `submenu` type menu items. If `submenu` is specified, the `type: 'submenu'` can be omitted.
|
19389
|
-
*/
|
19390
|
-
/**
|
19391
|
-
* @typedef {object} MenuResult@typedef {object} MenuResult
|
19392
|
-
* @property {'clicked' | 'closed'} result - Whether the user clicked on a menu item or the menu was closed (user clicked elsewhere).
|
19393
|
-
* @property {* | undefined} [data] - The data property of the menu item clicked by the user. Only defined if result was `clicked`.
|
19394
|
-
*/
|
19395
18420
|
/**
|
19396
18421
|
* Shows a menu on the window.
|
19397
18422
|
*
|
@@ -19488,615 +18513,565 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
19488
18513
|
*/
|
19489
18514
|
closePopupMenu(): Promise<void>;
|
19490
18515
|
/**
|
19491
|
-
*
|
19492
|
-
*
|
19493
|
-
* @
|
19494
|
-
* @
|
19495
|
-
*
|
19496
|
-
|
19497
|
-
|
19498
|
-
|
19499
|
-
|
19500
|
-
|
19501
|
-
|
19502
|
-
|
19503
|
-
|
19504
|
-
|
19505
|
-
|
19506
|
-
|
19507
|
-
|
19508
|
-
|
19509
|
-
|
19510
|
-
|
19511
|
-
|
19512
|
-
|
19513
|
-
|
19514
|
-
|
19515
|
-
|
19516
|
-
|
19517
|
-
|
19518
|
-
|
19519
|
-
|
19520
|
-
|
19521
|
-
|
19522
|
-
|
19523
|
-
|
19524
|
-
|
19525
|
-
|
19526
|
-
|
19527
|
-
|
19528
|
-
|
19529
|
-
|
19530
|
-
|
19531
|
-
|
19532
|
-
|
19533
|
-
|
19534
|
-
|
19535
|
-
|
19536
|
-
|
19537
|
-
|
19538
|
-
|
19539
|
-
|
19540
|
-
|
19541
|
-
|
19542
|
-
|
19543
|
-
|
19544
|
-
|
19545
|
-
|
19546
|
-
|
19547
|
-
|
19548
|
-
|
19549
|
-
|
19550
|
-
|
19551
|
-
|
19552
|
-
|
19553
|
-
|
19554
|
-
|
19555
|
-
|
19556
|
-
|
19557
|
-
|
19558
|
-
|
19559
|
-
|
19560
|
-
|
19561
|
-
|
19562
|
-
|
19563
|
-
|
19564
|
-
|
19565
|
-
|
19566
|
-
|
19567
|
-
|
19568
|
-
|
19569
|
-
|
19570
|
-
|
19571
|
-
|
19572
|
-
|
19573
|
-
|
19574
|
-
|
19575
|
-
|
19576
|
-
|
19577
|
-
|
19578
|
-
|
19579
|
-
|
19580
|
-
|
19581
|
-
|
19582
|
-
|
19583
|
-
|
19584
|
-
|
19585
|
-
|
19586
|
-
|
19587
|
-
|
19588
|
-
|
19589
|
-
|
19590
|
-
|
19591
|
-
|
19592
|
-
|
19593
|
-
|
19594
|
-
|
19595
|
-
|
19596
|
-
|
19597
|
-
|
19598
|
-
|
19599
|
-
|
19600
|
-
|
19601
|
-
|
19602
|
-
|
19603
|
-
|
19604
|
-
|
19605
|
-
|
19606
|
-
|
19607
|
-
|
19608
|
-
|
19609
|
-
|
19610
|
-
|
19611
|
-
|
19612
|
-
|
19613
|
-
|
19614
|
-
|
19615
|
-
|
19616
|
-
|
19617
|
-
|
19618
|
-
|
19619
|
-
|
19620
|
-
|
19621
|
-
|
19622
|
-
|
19623
|
-
|
19624
|
-
|
19625
|
-
|
19626
|
-
|
19627
|
-
|
19628
|
-
|
19629
|
-
|
19630
|
-
|
19631
|
-
|
19632
|
-
|
19633
|
-
|
19634
|
-
|
19635
|
-
|
19636
|
-
|
19637
|
-
|
19638
|
-
|
19639
|
-
|
19640
|
-
|
19641
|
-
|
19642
|
-
|
19643
|
-
|
19644
|
-
|
19645
|
-
|
19646
|
-
|
19647
|
-
|
19648
|
-
|
19649
|
-
|
19650
|
-
|
19651
|
-
|
19652
|
-
|
19653
|
-
|
19654
|
-
|
19655
|
-
|
19656
|
-
|
19657
|
-
|
19658
|
-
|
19659
|
-
|
19660
|
-
|
19661
|
-
|
19662
|
-
|
19663
|
-
|
19664
|
-
|
19665
|
-
|
19666
|
-
|
19667
|
-
|
19668
|
-
|
19669
|
-
|
19670
|
-
|
19671
|
-
|
19672
|
-
|
19673
|
-
|
19674
|
-
|
19675
|
-
|
19676
|
-
|
19677
|
-
|
19678
|
-
|
19679
|
-
|
19680
|
-
|
19681
|
-
|
19682
|
-
|
19683
|
-
|
19684
|
-
|
19685
|
-
|
19686
|
-
|
19687
|
-
|
19688
|
-
|
19689
|
-
|
19690
|
-
|
19691
|
-
|
19692
|
-
|
19693
|
-
|
19694
|
-
|
19695
|
-
|
19696
|
-
|
19697
|
-
|
19698
|
-
|
19699
|
-
|
19700
|
-
|
19701
|
-
|
19702
|
-
|
19703
|
-
|
19704
|
-
|
19705
|
-
|
19706
|
-
|
19707
|
-
|
19708
|
-
|
19709
|
-
|
19710
|
-
|
19711
|
-
|
19712
|
-
|
19713
|
-
|
19714
|
-
|
19715
|
-
|
19716
|
-
|
19717
|
-
|
19718
|
-
|
19719
|
-
|
19720
|
-
|
19721
|
-
|
19722
|
-
|
19723
|
-
|
19724
|
-
|
19725
|
-
|
19726
|
-
|
19727
|
-
|
19728
|
-
|
19729
|
-
|
19730
|
-
|
19731
|
-
|
19732
|
-
|
19733
|
-
|
19734
|
-
|
19735
|
-
|
19736
|
-
|
19737
|
-
|
19738
|
-
|
19739
|
-
|
19740
|
-
|
19741
|
-
|
19742
|
-
|
19743
|
-
|
19744
|
-
|
19745
|
-
|
19746
|
-
|
19747
|
-
|
19748
|
-
|
19749
|
-
|
19750
|
-
|
19751
|
-
|
19752
|
-
|
19753
|
-
|
19754
|
-
|
19755
|
-
|
19756
|
-
|
19757
|
-
|
19758
|
-
|
19759
|
-
|
19760
|
-
|
19761
|
-
|
19762
|
-
|
19763
|
-
|
19764
|
-
|
19765
|
-
|
19766
|
-
|
19767
|
-
|
19768
|
-
|
19769
|
-
|
19770
|
-
|
19771
|
-
|
19772
|
-
|
19773
|
-
|
19774
|
-
|
19775
|
-
|
19776
|
-
|
19777
|
-
|
19778
|
-
|
19779
|
-
|
19780
|
-
|
19781
|
-
|
19782
|
-
|
19783
|
-
|
19784
|
-
|
19785
|
-
|
19786
|
-
|
19787
|
-
|
19788
|
-
|
19789
|
-
|
19790
|
-
|
19791
|
-
|
19792
|
-
|
19793
|
-
|
19794
|
-
|
19795
|
-
|
19796
|
-
|
19797
|
-
|
19798
|
-
|
19799
|
-
|
19800
|
-
|
19801
|
-
|
19802
|
-
|
19803
|
-
|
19804
|
-
|
19805
|
-
|
19806
|
-
|
19807
|
-
|
19808
|
-
|
19809
|
-
|
19810
|
-
|
19811
|
-
|
19812
|
-
|
19813
|
-
|
19814
|
-
|
19815
|
-
|
19816
|
-
|
19817
|
-
|
19818
|
-
|
19819
|
-
|
19820
|
-
|
19821
|
-
|
19822
|
-
|
19823
|
-
|
19824
|
-
|
19825
|
-
|
19826
|
-
|
19827
|
-
|
19828
|
-
|
19829
|
-
|
19830
|
-
|
19831
|
-
|
19832
|
-
|
19833
|
-
|
19834
|
-
|
19835
|
-
|
19836
|
-
|
19837
|
-
|
19838
|
-
|
19839
|
-
|
19840
|
-
|
19841
|
-
|
19842
|
-
|
19843
|
-
|
19844
|
-
|
19845
|
-
|
19846
|
-
|
19847
|
-
|
19848
|
-
|
19849
|
-
|
19850
|
-
|
19851
|
-
|
19852
|
-
|
19853
|
-
|
19854
|
-
|
19855
|
-
|
19856
|
-
|
19857
|
-
|
19858
|
-
|
19859
|
-
|
19860
|
-
|
19861
|
-
|
19862
|
-
|
19863
|
-
|
19864
|
-
|
19865
|
-
|
19866
|
-
|
19867
|
-
|
19868
|
-
|
19869
|
-
|
19870
|
-
|
19871
|
-
|
19872
|
-
|
19873
|
-
|
19874
|
-
|
19875
|
-
|
19876
|
-
|
19877
|
-
|
19878
|
-
|
19879
|
-
|
19880
|
-
|
19881
|
-
|
19882
|
-
|
19883
|
-
|
19884
|
-
|
19885
|
-
|
19886
|
-
|
19887
|
-
|
19888
|
-
|
19889
|
-
|
19890
|
-
|
19891
|
-
|
19892
|
-
|
19893
|
-
|
19894
|
-
|
19895
|
-
|
19896
|
-
|
19897
|
-
|
19898
|
-
|
19899
|
-
|
19900
|
-
|
19901
|
-
|
19902
|
-
|
19903
|
-
|
19904
|
-
|
19905
|
-
|
19906
|
-
|
19907
|
-
|
19908
|
-
|
19909
|
-
|
19910
|
-
|
19911
|
-
|
19912
|
-
|
19913
|
-
|
19914
|
-
|
19915
|
-
|
19916
|
-
|
19917
|
-
|
19918
|
-
|
19919
|
-
|
19920
|
-
|
19921
|
-
|
19922
|
-
|
19923
|
-
|
19924
|
-
|
19925
|
-
|
19926
|
-
|
19927
|
-
|
19928
|
-
|
19929
|
-
|
19930
|
-
|
19931
|
-
|
19932
|
-
|
19933
|
-
|
19934
|
-
|
19935
|
-
|
19936
|
-
|
19937
|
-
|
19938
|
-
|
19939
|
-
|
19940
|
-
|
19941
|
-
|
19942
|
-
|
19943
|
-
|
19944
|
-
|
19945
|
-
|
19946
|
-
|
19947
|
-
|
19948
|
-
|
19949
|
-
|
19950
|
-
|
19951
|
-
|
19952
|
-
|
19953
|
-
|
19954
|
-
|
19955
|
-
|
19956
|
-
|
19957
|
-
|
19958
|
-
|
19959
|
-
|
19960
|
-
|
19961
|
-
|
19962
|
-
|
19963
|
-
|
19964
|
-
|
19965
|
-
|
19966
|
-
|
19967
|
-
|
19968
|
-
|
19969
|
-
|
19970
|
-
|
19971
|
-
|
19972
|
-
|
19973
|
-
|
19974
|
-
|
19975
|
-
|
19976
|
-
|
19977
|
-
|
19978
|
-
|
19979
|
-
|
19980
|
-
|
19981
|
-
|
19982
|
-
|
19983
|
-
|
19984
|
-
|
19985
|
-
|
19986
|
-
|
19987
|
-
|
19988
|
-
|
19989
|
-
|
19990
|
-
|
19991
|
-
|
19992
|
-
|
19993
|
-
|
19994
|
-
|
19995
|
-
|
19996
|
-
|
19997
|
-
|
19998
|
-
|
19999
|
-
|
20000
|
-
|
20001
|
-
|
20002
|
-
|
20003
|
-
|
20004
|
-
|
20005
|
-
|
20006
|
-
|
20007
|
-
|
20008
|
-
|
20009
|
-
|
20010
|
-
|
20011
|
-
|
20012
|
-
|
20013
|
-
|
20014
|
-
|
20015
|
-
|
20016
|
-
|
20017
|
-
|
20018
|
-
|
20019
|
-
|
20020
|
-
|
20021
|
-
|
20022
|
-
|
20023
|
-
|
20024
|
-
|
20025
|
-
|
20026
|
-
|
20027
|
-
|
20028
|
-
|
20029
|
-
|
20030
|
-
|
20031
|
-
|
20032
|
-
|
20033
|
-
|
20034
|
-
|
20035
|
-
|
20036
|
-
|
20037
|
-
|
20038
|
-
|
20039
|
-
|
20040
|
-
|
20041
|
-
|
20042
|
-
|
20043
|
-
|
20044
|
-
|
20045
|
-
|
20046
|
-
|
20047
|
-
|
20048
|
-
|
20049
|
-
|
20050
|
-
|
20051
|
-
|
20052
|
-
|
20053
|
-
*/
|
20054
|
-
data: {
|
20055
|
-
text?: string;
|
20056
|
-
html?: string;
|
20057
|
-
rtf?: string;
|
20058
|
-
} & Partial<Pick<WriteImageClipboardRequest, 'image'>>;
|
20059
|
-
};
|
20060
|
-
|
20061
|
-
/**
|
20062
|
-
* @deprecated - instead use WriteAnyClipboardRequest
|
20063
|
-
*
|
20064
|
-
* A generic request to write any supported data to the clipboard.
|
20065
|
-
*
|
20066
|
-
* @interface
|
20067
|
-
*/
|
20068
|
-
declare type WriteAnyRequestType = WriteAnyClipboardRequest;
|
20069
|
-
|
20070
|
-
/**
|
20071
|
-
* A request to write data to the clipboard.
|
20072
|
-
* @interface
|
20073
|
-
*/
|
20074
|
-
declare type WriteClipboardRequest = BaseClipboardRequest & {
|
20075
|
-
/**
|
20076
|
-
* Data to write to the clipboard.
|
20077
|
-
*/
|
20078
|
-
data: string;
|
20079
|
-
};
|
20080
|
-
|
20081
|
-
/**
|
20082
|
-
* @interface
|
20083
|
-
*/
|
20084
|
-
declare type WriteImageClipboardRequest = BaseClipboardRequest & {
|
20085
|
-
/**
|
20086
|
-
* Can be either a base64 string, or a DataURL string. If using DataURL, the
|
20087
|
-
* supported formats are `data:image/png[;base64],` and `data:image/jpeg[;base64],`.
|
20088
|
-
* Using other image/<format> DataURLs will throw an Error.
|
20089
|
-
*/
|
20090
|
-
image: string;
|
20091
|
-
};
|
20092
|
-
|
20093
|
-
/**
|
20094
|
-
* @deprecated - instead use OpenFin.WriteClipboardRequest
|
20095
|
-
*
|
20096
|
-
* A request to write data to the clipboard.
|
20097
|
-
*
|
20098
|
-
* @interface
|
20099
|
-
*/
|
20100
|
-
declare type WriteRequestType = WriteClipboardRequest;
|
20101
|
-
|
20102
|
-
export { }
|
18516
|
+
* Dispatch a result to the caller of `showPopupWindow`.
|
18517
|
+
*
|
18518
|
+
* @remarks If this window isn't currently being shown as a popup, this call will silently fail.
|
18519
|
+
* @param data Serializable data to send to the caller window.
|
18520
|
+
*
|
18521
|
+
* @example
|
18522
|
+
* ```js
|
18523
|
+
* await fin.me.dispatchPopupResult({
|
18524
|
+
* foo: 'bar'
|
18525
|
+
* });
|
18526
|
+
* ```
|
18527
|
+
*/
|
18528
|
+
dispatchPopupResult(data: any): Promise<void>;
|
18529
|
+
/**
|
18530
|
+
* Prints the contents of the window.
|
18531
|
+
*
|
18532
|
+
* @param options Configuration for the print task.
|
18533
|
+
* @remarks When `silent` is set to `true`, the API will pick the system's default printer if deviceName is empty
|
18534
|
+
* and the default settings for printing.
|
18535
|
+
*
|
18536
|
+
* Use the CSS style `page-break-before: always;` to force print to a new page.
|
18537
|
+
*
|
18538
|
+
* @example
|
18539
|
+
* ```js
|
18540
|
+
* const win = fin.Window.getCurrentSync();
|
18541
|
+
*
|
18542
|
+
* win.print({ silent: false, deviceName: 'system-printer-name' }).then(() => {
|
18543
|
+
* console.log('print call has been sent to the system');
|
18544
|
+
* });
|
18545
|
+
* ```
|
18546
|
+
*
|
18547
|
+
* If a window has embedded views, those views will not print by default. To print a window's contents including embedded views,
|
18548
|
+
* use the `content` option:
|
18549
|
+
*
|
18550
|
+
* ```js
|
18551
|
+
* const win = fin.Window.getCurrentSync();
|
18552
|
+
*
|
18553
|
+
* // Print embedded views
|
18554
|
+
* win.print({ content: 'views' });
|
18555
|
+
*
|
18556
|
+
* // Print screenshot of current window
|
18557
|
+
* win.print({ content: 'screenshot' })
|
18558
|
+
* ```
|
18559
|
+
*
|
18560
|
+
* When `content` is set to `views`, the embedded views in the platform window will be concatenated and printed as
|
18561
|
+
* individual pages. If `includeSelf` is set to `true`, the platform window itself will be printed as the first
|
18562
|
+
* page - be aware that this page will *not* include the embedded views - it will only include the contents of
|
18563
|
+
* the platform window itself (e.g. tab stacks), with blank spaces where the view contents would be embedded.
|
18564
|
+
*
|
18565
|
+
* Due to a known issue, view contents that are not visible at the time `print` is called will not appear when
|
18566
|
+
* printing `contents: views`. This includes views that are obscured behind other active UI elements.
|
18567
|
+
*
|
18568
|
+
* To print the views embedded in their page context, set `content` to `screenshot`.
|
18569
|
+
*/
|
18570
|
+
print(options?: OpenFin.WindowPrintOptions): Promise<void>;
|
18571
|
+
}
|
18572
|
+
|
18573
|
+
/**
|
18574
|
+
* Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
|
18575
|
+
* @interface
|
18576
|
+
*/
|
18577
|
+
declare type WindowAlertRequestedEvent = BaseEvent_3 & {
|
18578
|
+
type: 'window-alert-requested';
|
18579
|
+
};
|
18580
|
+
|
18581
|
+
/**
|
18582
|
+
* Returned from getBounds call. bottom and right are never used for setting.
|
18583
|
+
* @interface
|
18584
|
+
*/
|
18585
|
+
declare type WindowBounds = Bounds & {
|
18586
|
+
bottom: number;
|
18587
|
+
right: number;
|
18588
|
+
};
|
18589
|
+
|
18590
|
+
/**
|
18591
|
+
* @deprecated Renamed to {@link ClosedEvent}.
|
18592
|
+
*/
|
18593
|
+
declare type WindowClosedEvent = ClosedEvent_2;
|
18594
|
+
|
18595
|
+
/**
|
18596
|
+
* @deprecated Renamed to {@link CloseRequestedEvent}.
|
18597
|
+
*/
|
18598
|
+
declare type WindowCloseRequestedEvent = CloseRequestedEvent;
|
18599
|
+
|
18600
|
+
/**
|
18601
|
+
* @deprecated Renamed to {@link ClosingEvent}.
|
18602
|
+
*/
|
18603
|
+
declare type WindowClosingEvent = ClosingEvent;
|
18604
|
+
|
18605
|
+
/**
|
18606
|
+
* A rule prescribing content creation in a {@link OpenFin.Window}.
|
18607
|
+
*
|
18608
|
+
* @interface
|
18609
|
+
*/
|
18610
|
+
declare type WindowContentCreationRule = BaseContentCreationRule & {
|
18611
|
+
/**
|
18612
|
+
* Behavior to use when opening matched content.
|
18613
|
+
*/
|
18614
|
+
behavior: 'window';
|
18615
|
+
/**
|
18616
|
+
* Options for newly-created window.
|
18617
|
+
*/
|
18618
|
+
options?: Partial<WindowOptions>;
|
18619
|
+
};
|
18620
|
+
|
18621
|
+
/**
|
18622
|
+
* Generated when a child window is created.
|
18623
|
+
* @interface
|
18624
|
+
*/
|
18625
|
+
declare type WindowCreatedEvent = BaseEvent_3 & {
|
18626
|
+
type: 'window-created';
|
18627
|
+
};
|
18628
|
+
|
18629
|
+
/**
|
18630
|
+
* Options required to create a new window with {@link Window._WindowModule.create Window.create}.
|
18631
|
+
*
|
18632
|
+
* Note that `name` is the only required property — albeit the `url` property is usually provided as well
|
18633
|
+
* (defaults to `"about:blank"` when omitted).
|
18634
|
+
* @interface
|
18635
|
+
*/
|
18636
|
+
declare type WindowCreationOptions = Partial<WindowOptions> & {
|
18637
|
+
name: string;
|
18638
|
+
};
|
18639
|
+
|
18640
|
+
declare type WindowCreationReason = 'tearout' | 'create-view-without-target' | 'api-call' | 'app-creation' | 'restore' | 'apply-snapshot';
|
18641
|
+
|
18642
|
+
/**
|
18643
|
+
* @interface
|
18644
|
+
*/
|
18645
|
+
declare type WindowDetail = {
|
18646
|
+
/**
|
18647
|
+
* The bottom-most coordinate of the window.
|
18648
|
+
*/
|
18649
|
+
bottom: number;
|
18650
|
+
/**
|
18651
|
+
* The height of the window.
|
18652
|
+
*/
|
18653
|
+
height: number;
|
18654
|
+
isShowing: boolean;
|
18655
|
+
/**
|
18656
|
+
* The left-most coordinate of the window.
|
18657
|
+
*/
|
18658
|
+
left: number;
|
18659
|
+
/**
|
18660
|
+
* The name of the window.
|
18661
|
+
*/
|
18662
|
+
name: string;
|
18663
|
+
/**
|
18664
|
+
* The right-most coordinate of the window.
|
18665
|
+
*/
|
18666
|
+
right: number;
|
18667
|
+
state: string;
|
18668
|
+
/**
|
18669
|
+
* The top-most coordinate of the window.
|
18670
|
+
*/
|
18671
|
+
top: number;
|
18672
|
+
/**
|
18673
|
+
* The width of the window.
|
18674
|
+
*/
|
18675
|
+
width: number;
|
18676
|
+
};
|
18677
|
+
|
18678
|
+
/**
|
18679
|
+
* Generated when a child window ends loading.
|
18680
|
+
* @interface
|
18681
|
+
*/
|
18682
|
+
declare type WindowEndLoadEvent = BaseEvent_3 & {
|
18683
|
+
type: 'window-end-load';
|
18684
|
+
};
|
18685
|
+
|
18686
|
+
/**
|
18687
|
+
* @deprecated, Renamed to {@link Event}.
|
18688
|
+
*/
|
18689
|
+
declare type WindowEvent = Event_6;
|
18690
|
+
|
18691
|
+
declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
|
18692
|
+
|
18693
|
+
declare namespace WindowEvents {
|
18694
|
+
export {
|
18695
|
+
BaseEvent_5 as BaseEvent,
|
18696
|
+
BaseWindowEvent,
|
18697
|
+
ViewAttachedEvent,
|
18698
|
+
ViewDetachedEvent,
|
18699
|
+
WindowViewEvent,
|
18700
|
+
AlertRequestedEvent,
|
18701
|
+
AuthRequestedEvent,
|
18702
|
+
EndLoadEvent,
|
18703
|
+
WillRedirectEvent,
|
18704
|
+
ReloadedEvent,
|
18705
|
+
OptionsChangedEvent,
|
18706
|
+
WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
|
18707
|
+
ExternalProcessExitedEvent,
|
18708
|
+
ExternalProcessStartedEvent,
|
18709
|
+
HiddenEvent_2 as HiddenEvent,
|
18710
|
+
WindowHiddenEvent,
|
18711
|
+
PreloadScriptInfoRunning,
|
18712
|
+
PreloadScriptInfo,
|
18713
|
+
PreloadScriptsStateChangeEvent,
|
18714
|
+
UserBoundsChangeEvent,
|
18715
|
+
BoundsChangeEvent,
|
18716
|
+
WillMoveOrResizeEvent,
|
18717
|
+
PerformanceReportEvent,
|
18718
|
+
InputEvent_2 as InputEvent,
|
18719
|
+
LayoutInitializedEvent,
|
18720
|
+
LayoutReadyEvent,
|
18721
|
+
BeginUserBoundsChangingEvent,
|
18722
|
+
BoundsChangedEvent,
|
18723
|
+
BoundsChangingEvent,
|
18724
|
+
CloseRequestedEvent,
|
18725
|
+
WindowCloseRequestedEvent,
|
18726
|
+
ContextChangedEvent,
|
18727
|
+
ClosedEvent_2 as ClosedEvent,
|
18728
|
+
WindowClosedEvent,
|
18729
|
+
ClosingEvent,
|
18730
|
+
WindowClosingEvent,
|
18731
|
+
DisabledMovementBoundsChangedEvent,
|
18732
|
+
DisabledMovementBoundsChangingEvent,
|
18733
|
+
EmbeddedEvent,
|
18734
|
+
EndUserBoundsChangingEvent,
|
18735
|
+
HotkeyEvent_2 as HotkeyEvent,
|
18736
|
+
WindowHotkeyEvent,
|
18737
|
+
InitializedEvent_2 as InitializedEvent,
|
18738
|
+
WindowInitializedEvent,
|
18739
|
+
MaximizedEvent,
|
18740
|
+
MinimizedEvent,
|
18741
|
+
PreloadScriptsStateChangedEvent,
|
18742
|
+
PreloadScriptsStateChangingEvent,
|
18743
|
+
RestoredEvent,
|
18744
|
+
WindowRestoredEvent,
|
18745
|
+
ShowRequestedEvent,
|
18746
|
+
WindowShowRequestedEvent,
|
18747
|
+
ShownEvent_2 as ShownEvent,
|
18748
|
+
WindowShownEvent,
|
18749
|
+
UserMovementEnabledEvent,
|
18750
|
+
UserMovementDisabledEvent,
|
18751
|
+
WillMoveEvent,
|
18752
|
+
WillResizeEvent,
|
18753
|
+
NonPropagatedWindowEvent,
|
18754
|
+
ShowAllDownloadsEvent,
|
18755
|
+
DownloadShelfVisibilityChangedEvent,
|
18756
|
+
WindowSourcedEvent,
|
18757
|
+
WillPropagateWindowEvent,
|
18758
|
+
Event_6 as Event,
|
18759
|
+
WindowEvent,
|
18760
|
+
EventType_2 as EventType,
|
18761
|
+
WindowEventType,
|
18762
|
+
PropagatedEvent_3 as PropagatedEvent,
|
18763
|
+
PropagatedWindowEvent,
|
18764
|
+
PropagatedWindowEventType,
|
18765
|
+
Payload_3 as Payload,
|
18766
|
+
ByType_2 as ByType
|
18767
|
+
}
|
18768
|
+
}
|
18769
|
+
|
18770
|
+
/**
|
18771
|
+
* @deprecated Renamed to {@link EventType}.
|
18772
|
+
*/
|
18773
|
+
declare type WindowEventType = WindowEvent['type'];
|
18774
|
+
|
18775
|
+
/**
|
18776
|
+
* @deprecated Renamed to {@link HiddenEvent}.
|
18777
|
+
*/
|
18778
|
+
declare type WindowHiddenEvent = HiddenEvent_2;
|
18779
|
+
|
18780
|
+
/**
|
18781
|
+
* @deprecated Renamed to {@link HotkeyEvent}.
|
18782
|
+
*/
|
18783
|
+
declare type WindowHotkeyEvent = HotkeyEvent_2;
|
18784
|
+
|
18785
|
+
/**
|
18786
|
+
* @interface
|
18787
|
+
*/
|
18788
|
+
declare type WindowInfo = {
|
18789
|
+
canNavigateBack: boolean;
|
18790
|
+
canNavigateForward: boolean;
|
18791
|
+
preloadScripts: Array<any>;
|
18792
|
+
title: string;
|
18793
|
+
url: string;
|
18794
|
+
};
|
18795
|
+
|
18796
|
+
/**
|
18797
|
+
* @deprecated Renamed to {@link InitializedEvent}.
|
18798
|
+
*/
|
18799
|
+
declare type WindowInitializedEvent = InitializedEvent_2;
|
18800
|
+
|
18801
|
+
/**
|
18802
|
+
* Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
|
18803
|
+
*/
|
18804
|
+
declare class _WindowModule extends Base {
|
18805
|
+
/**
|
18806
|
+
* Asynchronously returns a Window object that represents an existing window.
|
18807
|
+
*
|
18808
|
+
* @example
|
18809
|
+
* ```js
|
18810
|
+
* async function createWin() {
|
18811
|
+
* const app = await fin.Application.start({
|
18812
|
+
* name: 'myApp',
|
18813
|
+
* uuid: 'app-1',
|
18814
|
+
* url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrap.html',
|
18815
|
+
* autoShow: true
|
18816
|
+
* });
|
18817
|
+
* return await app.getWindow();
|
18818
|
+
* }
|
18819
|
+
* createWin().then(() => fin.Window.wrap({ uuid: 'app-1', name: 'myApp' }))
|
18820
|
+
* .then(win => console.log('wrapped window'))
|
18821
|
+
* .catch(err => console.log(err));
|
18822
|
+
* ```
|
18823
|
+
*/
|
18824
|
+
wrap(identity: OpenFin.Identity): Promise<OpenFin.Window>;
|
18825
|
+
/**
|
18826
|
+
* Synchronously returns a Window object that represents an existing window.
|
18827
|
+
*
|
18828
|
+
* @example
|
18829
|
+
* ```js
|
18830
|
+
* async function createWin() {
|
18831
|
+
* const app = await fin.Application.start({
|
18832
|
+
* name: 'myApp',
|
18833
|
+
* uuid: 'app-1',
|
18834
|
+
* url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrapSync.html',
|
18835
|
+
* autoShow: true
|
18836
|
+
* });
|
18837
|
+
* return await app.getWindow();
|
18838
|
+
* }
|
18839
|
+
* await createWin();
|
18840
|
+
* let win = fin.Window.wrapSync({ uuid: 'app-1', name: 'myApp' });
|
18841
|
+
* ```
|
18842
|
+
*/
|
18843
|
+
wrapSync(identity: OpenFin.Identity): OpenFin.Window;
|
18844
|
+
/**
|
18845
|
+
* Creates a new Window.
|
18846
|
+
* @param options - Window creation options
|
18847
|
+
*
|
18848
|
+
* @example
|
18849
|
+
* ```js
|
18850
|
+
* async function createWindow() {
|
18851
|
+
* const winOption = {
|
18852
|
+
* name:'child',
|
18853
|
+
* defaultWidth: 300,
|
18854
|
+
* defaultHeight: 300,
|
18855
|
+
* url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.create.html',
|
18856
|
+
* frame: true,
|
18857
|
+
* autoShow: true
|
18858
|
+
* };
|
18859
|
+
* return await fin.Window.create(winOption);
|
18860
|
+
* }
|
18861
|
+
*
|
18862
|
+
* createWindow().then(() => console.log('Window is created')).catch(err => console.log(err));
|
18863
|
+
* ```
|
18864
|
+
*/
|
18865
|
+
create(options: OpenFin.WindowCreationOptions): Promise<OpenFin.Window>;
|
18866
|
+
/**
|
18867
|
+
* Asynchronously returns a Window object that represents the current window
|
18868
|
+
*
|
18869
|
+
* @example
|
18870
|
+
* ```js
|
18871
|
+
* fin.Window.getCurrent()
|
18872
|
+
* .then(wnd => console.log('current window'))
|
18873
|
+
* .catch(err => console.log(err));
|
18874
|
+
*
|
18875
|
+
* ```
|
18876
|
+
*/
|
18877
|
+
getCurrent(): Promise<OpenFin.Window>;
|
18878
|
+
/**
|
18879
|
+
* Synchronously returns a Window object that represents the current window
|
18880
|
+
*
|
18881
|
+
* @example
|
18882
|
+
* ```js
|
18883
|
+
* const wnd = fin.Window.getCurrentSync();
|
18884
|
+
* const info = await wnd.getInfo();
|
18885
|
+
* console.log(info);
|
18886
|
+
*
|
18887
|
+
* ```
|
18888
|
+
*/
|
18889
|
+
getCurrentSync(): OpenFin.Window;
|
18890
|
+
}
|
18891
|
+
|
18892
|
+
/**
|
18893
|
+
* Generated when a child window is not responding.
|
18894
|
+
* @interface
|
18895
|
+
*/
|
18896
|
+
declare type WindowNotRespondingEvent = BaseEvent_3 & {
|
18897
|
+
type: 'window-not-responding';
|
18898
|
+
};
|
18899
|
+
|
18900
|
+
/**
|
18901
|
+
* @interface
|
18902
|
+
*/
|
18903
|
+
declare type WindowOptionDiff = {
|
18904
|
+
[key in keyof WindowOptions]: {
|
18905
|
+
oldVal: WindowOptions[key];
|
18906
|
+
newVal: WindowOptions[key];
|
18907
|
+
};
|
18908
|
+
};
|
18909
|
+
|
18910
|
+
/**
|
18911
|
+
* @interface
|
18912
|
+
*/
|
18913
|
+
declare type WindowOptions = MutableWindowOptions & ConstWindowOptions;
|
18914
|
+
|
18915
|
+
declare type WindowOptionsChangedEvent = OpenFin.WindowEvents.WindowOptionsChangedEvent;
|
18916
|
+
|
18917
|
+
/**
|
18918
|
+
* @deprecated Renamed to {@link OptionsChangedEvent}.
|
18919
|
+
*/
|
18920
|
+
declare type WindowOptionsChangedEvent_2 = OptionsChangedEvent;
|
18921
|
+
|
18922
|
+
declare type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
|
18923
|
+
|
18924
|
+
/**
|
18925
|
+
* Generated when a child window is responding.
|
18926
|
+
* @interface
|
18927
|
+
*/
|
18928
|
+
declare type WindowRespondingEvent = BaseEvent_3 & {
|
18929
|
+
type: 'window-responding';
|
18930
|
+
};
|
18931
|
+
|
18932
|
+
/**
|
18933
|
+
* @deprecated Renamed to {@link RestoredEvent}.
|
18934
|
+
*/
|
18935
|
+
declare type WindowRestoredEvent = RestoredEvent;
|
18936
|
+
|
18937
|
+
/**
|
18938
|
+
* @deprecated Renamed to {@link ShownEvent}.
|
18939
|
+
*/
|
18940
|
+
declare type WindowShownEvent = ShownEvent_2;
|
18941
|
+
|
18942
|
+
/**
|
18943
|
+
* @deprecated Renamed to {@link ShowRequestedEvent}.
|
18944
|
+
*/
|
18945
|
+
declare type WindowShowRequestedEvent = ShowRequestedEvent;
|
18946
|
+
|
18947
|
+
/**
|
18948
|
+
* A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
|
18949
|
+
* from {@link OpenFin.ViewEvents}.
|
18950
|
+
*/
|
18951
|
+
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;
|
18952
|
+
|
18953
|
+
/**
|
18954
|
+
* Generated when a child window starts loading.
|
18955
|
+
* @interface
|
18956
|
+
*/
|
18957
|
+
declare type WindowStartLoadEvent = BaseEvent_3 & {
|
18958
|
+
type: 'window-start-load';
|
18959
|
+
};
|
18960
|
+
|
18961
|
+
/**
|
18962
|
+
* Visibility state of a window.
|
18963
|
+
*/
|
18964
|
+
declare type WindowState = 'maximized' | 'minimized' | 'normal';
|
18965
|
+
|
18966
|
+
/**
|
18967
|
+
* A view-related event that fires natively on the `Window` topic. This means that these events *do* propagate
|
18968
|
+
* to the `Application` level, with the name pattern `window-view-eventname`.
|
18969
|
+
*/
|
18970
|
+
declare type WindowViewEvent = {
|
18971
|
+
viewIdentity: OpenFin.Identity;
|
18972
|
+
} & (ViewAttachedEvent | ViewDetachedEvent);
|
18973
|
+
|
18974
|
+
/**
|
18975
|
+
* @interface
|
18976
|
+
*/
|
18977
|
+
declare type WindowViewsPrintOptions = {
|
18978
|
+
content: 'views';
|
18979
|
+
includeSelf?: boolean;
|
18980
|
+
};
|
18981
|
+
|
18982
|
+
declare type Wire = EventEmitter & {
|
18983
|
+
connect(messageReciever: MessageReceiver): Promise<any>;
|
18984
|
+
connectSync(): any;
|
18985
|
+
send(data: any): Promise<any>;
|
18986
|
+
shutdown(): Promise<void>;
|
18987
|
+
getPort(): string;
|
18988
|
+
};
|
18989
|
+
|
18990
|
+
declare type WireConstructor = {
|
18991
|
+
new (onmessage: (data: any) => void): Wire;
|
18992
|
+
};
|
18993
|
+
|
18994
|
+
/**
|
18995
|
+
* @internal
|
18996
|
+
*/
|
18997
|
+
declare type WithId<T extends AppVersionEventType> = `${T}.${string}`;
|
18998
|
+
|
18999
|
+
declare interface WithInterop {
|
19000
|
+
interop: InteropClient;
|
19001
|
+
}
|
19002
|
+
|
19003
|
+
/**
|
19004
|
+
* @internal
|
19005
|
+
*/
|
19006
|
+
declare type WithoutId<T extends string> = T extends WithId<infer U> ? U : never;
|
19007
|
+
|
19008
|
+
declare type WithPositioningOptions<T extends {} = {}> = T & {
|
19009
|
+
positioningOptions?: OpenFin.PositioningOptions;
|
19010
|
+
};
|
19011
|
+
|
19012
|
+
/**
|
19013
|
+
* @internal
|
19014
|
+
* @interface
|
19015
|
+
*/
|
19016
|
+
declare type WorkspacePlatformOptions = {
|
19017
|
+
/** Leaving this as any for now until we figure out what the shape should look like in Workspace */
|
19018
|
+
[key: string]: any;
|
19019
|
+
};
|
19020
|
+
|
19021
|
+
/**
|
19022
|
+
* A generic request to write any supported data to the clipboard.
|
19023
|
+
* @interface
|
19024
|
+
*/
|
19025
|
+
declare type WriteAnyClipboardRequest = BaseClipboardRequest & {
|
19026
|
+
/**
|
19027
|
+
* Data to be written
|
19028
|
+
*/
|
19029
|
+
data: {
|
19030
|
+
text?: string;
|
19031
|
+
html?: string;
|
19032
|
+
rtf?: string;
|
19033
|
+
} & Partial<Pick<WriteImageClipboardRequest, 'image'>>;
|
19034
|
+
};
|
19035
|
+
|
19036
|
+
/**
|
19037
|
+
* @deprecated - instead use WriteAnyClipboardRequest
|
19038
|
+
*
|
19039
|
+
* A generic request to write any supported data to the clipboard.
|
19040
|
+
*
|
19041
|
+
* @interface
|
19042
|
+
*/
|
19043
|
+
declare type WriteAnyRequestType = WriteAnyClipboardRequest;
|
19044
|
+
|
19045
|
+
/**
|
19046
|
+
* A request to write data to the clipboard.
|
19047
|
+
* @interface
|
19048
|
+
*/
|
19049
|
+
declare type WriteClipboardRequest = BaseClipboardRequest & {
|
19050
|
+
/**
|
19051
|
+
* Data to write to the clipboard.
|
19052
|
+
*/
|
19053
|
+
data: string;
|
19054
|
+
};
|
19055
|
+
|
19056
|
+
/**
|
19057
|
+
* @interface
|
19058
|
+
*/
|
19059
|
+
declare type WriteImageClipboardRequest = BaseClipboardRequest & {
|
19060
|
+
/**
|
19061
|
+
* Can be either a base64 string, or a DataURL string. If using DataURL, the
|
19062
|
+
* supported formats are `data:image/png[;base64],` and `data:image/jpeg[;base64],`.
|
19063
|
+
* Using other image/<format> DataURLs will throw an Error.
|
19064
|
+
*/
|
19065
|
+
image: string;
|
19066
|
+
};
|
19067
|
+
|
19068
|
+
/**
|
19069
|
+
* @deprecated - instead use OpenFin.WriteClipboardRequest
|
19070
|
+
*
|
19071
|
+
* A request to write data to the clipboard.
|
19072
|
+
*
|
19073
|
+
* @interface
|
19074
|
+
*/
|
19075
|
+
declare type WriteRequestType = WriteClipboardRequest;
|
19076
|
+
|
19077
|
+
export { }
|