@openfin/core 35.78.1 → 35.78.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/out/mock-alpha.d.ts +1353 -2138
- package/out/mock-beta.d.ts +1353 -2138
- package/out/mock-public.d.ts +1353 -2138
- package/out/mock.d.ts +1400 -2364
- package/out/mock.js +86 -1410
- package/package.json +2 -2
package/out/mock-public.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 'none', `fin` won't be available in this context.
|
|
101
|
+
*/
|
|
102
|
+
fin?: InjectionType;
|
|
97
103
|
};
|
|
98
104
|
|
|
99
105
|
declare type ApiCall<Request, Response> = {
|
|
@@ -105,6 +111,22 @@ declare type ApiClient<T extends Record<any, any>> = {
|
|
|
105
111
|
[key in keyof PickOfType<T, Function>]: (...args: Parameters<T[key]>) => ReturnType<T[key]> extends Promise<any> ? ReturnType<T[key]> : Promise<ReturnType<T[key]>>;
|
|
106
112
|
};
|
|
107
113
|
|
|
114
|
+
/**
|
|
115
|
+
* @interface
|
|
116
|
+
*/
|
|
117
|
+
declare type ApiInjection = {
|
|
118
|
+
fin: InjectionType;
|
|
119
|
+
};
|
|
120
|
+
|
|
121
|
+
/**
|
|
122
|
+
* Generated when a new Platform's API becomes responsive.
|
|
123
|
+
* @interface
|
|
124
|
+
*/
|
|
125
|
+
declare type ApiReadyEvent = BaseEvent & {
|
|
126
|
+
topic: 'application';
|
|
127
|
+
type: 'platform-api-ready';
|
|
128
|
+
};
|
|
129
|
+
|
|
108
130
|
/**
|
|
109
131
|
* @interface
|
|
110
132
|
*/
|
|
@@ -178,100 +200,6 @@ declare class Application extends EmitterBase<OpenFin_2.ApplicationEvent> {
|
|
|
178
200
|
private window;
|
|
179
201
|
/* Excluded from this release type: __constructor */
|
|
180
202
|
private windowListFromIdentityList;
|
|
181
|
-
/**
|
|
182
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
|
183
|
-
* @param eventType - The type of the event.
|
|
184
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
|
185
|
-
* @param options - Option to support event timestamps.
|
|
186
|
-
*
|
|
187
|
-
* @function addListener
|
|
188
|
-
* @memberof Application
|
|
189
|
-
* @instance
|
|
190
|
-
* @tutorial Application.EventEmitter
|
|
191
|
-
*/
|
|
192
|
-
/**
|
|
193
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
|
194
|
-
* @param eventType - The type of the event.
|
|
195
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
|
196
|
-
* @param options - Option to support event timestamps.
|
|
197
|
-
*
|
|
198
|
-
* @function on
|
|
199
|
-
* @memberof Application
|
|
200
|
-
* @instance
|
|
201
|
-
* @tutorial Application.EventEmitter
|
|
202
|
-
*/
|
|
203
|
-
/**
|
|
204
|
-
* Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
|
|
205
|
-
* @param eventType - The type of the event.
|
|
206
|
-
* @param listener - The callback function.
|
|
207
|
-
* @param options - Option to support event timestamps.
|
|
208
|
-
*
|
|
209
|
-
* @function once
|
|
210
|
-
* @memberof Application
|
|
211
|
-
* @instance
|
|
212
|
-
* @tutorial Application.EventEmitter
|
|
213
|
-
*/
|
|
214
|
-
/**
|
|
215
|
-
* Adds a listener to the beginning of the listeners array for the specified event.
|
|
216
|
-
* @param eventType - The type of the event.
|
|
217
|
-
* @param listener - The callback function.
|
|
218
|
-
* @param options - Option to support event timestamps.
|
|
219
|
-
*
|
|
220
|
-
* @function prependListener
|
|
221
|
-
* @memberof Application
|
|
222
|
-
* @instance
|
|
223
|
-
* @tutorial Application.EventEmitter
|
|
224
|
-
*/
|
|
225
|
-
/**
|
|
226
|
-
* Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
|
|
227
|
-
* The listener is added to the beginning of the listeners array.
|
|
228
|
-
* @param eventType - The type of the event.
|
|
229
|
-
* @param listener - The callback function.
|
|
230
|
-
* @param options - Option to support event timestamps.
|
|
231
|
-
*
|
|
232
|
-
* @function prependOnceListener
|
|
233
|
-
* @memberof Application
|
|
234
|
-
* @instance
|
|
235
|
-
* @tutorial Application.EventEmitter
|
|
236
|
-
*/
|
|
237
|
-
/**
|
|
238
|
-
* Remove a listener from the listener array for the specified event.
|
|
239
|
-
* Caution: Calling this method changes the array indices in the listener array behind the listener.
|
|
240
|
-
* @param eventType - The type of the event.
|
|
241
|
-
* @param listener - The callback function.
|
|
242
|
-
* @param options - Option to support event timestamps.
|
|
243
|
-
*
|
|
244
|
-
* @function removeListener
|
|
245
|
-
* @memberof Application
|
|
246
|
-
* @instance
|
|
247
|
-
* @tutorial Application.EventEmitter
|
|
248
|
-
*/
|
|
249
|
-
/**
|
|
250
|
-
* Removes all listeners, or those of the specified event.
|
|
251
|
-
* @param eventType - The type of the event.
|
|
252
|
-
*
|
|
253
|
-
* @function removeAllListeners
|
|
254
|
-
* @memberof Application
|
|
255
|
-
* @instance
|
|
256
|
-
* @tutorial Application.EventEmitter
|
|
257
|
-
*/
|
|
258
|
-
/**
|
|
259
|
-
* JumpListCategory interface
|
|
260
|
-
* @typedef { object } JumpListCategory@typedef { object } JumpListCategory
|
|
261
|
-
* @property { string } name The display title for the category. If omitted, items in this category will be placed into the standard 'Tasks' category. There can be only one such category, and it will always be displayed at the bottom of the JumpList.
|
|
262
|
-
* @property { JumpListItem[] } items Array of JumpListItem objects
|
|
263
|
-
*/
|
|
264
|
-
/**
|
|
265
|
-
* @PORTED
|
|
266
|
-
* JumpListItem interface
|
|
267
|
-
* @typedef { object } JumpListItem@typedef { object } JumpListItem
|
|
268
|
-
* @property { string } type One of the following: "task" or "separator". Defaults to task.
|
|
269
|
-
* @property { string } title The text to be displayed for the JumpList Item. Should only be set if type is "task".
|
|
270
|
-
* @property { string } description Description of the task (displayed in a tooltip). Should only be set if type is "task".
|
|
271
|
-
* @property { string } deepLink Deep link to a manifest, i.e: fins://path.to/manifest.json?$$param1=value1. See {@link https://developers.openfin.co/docs/deep-linking deep-linking} for more information.
|
|
272
|
-
* @property { string } iconPath The absolute path to an icon to be displayed for the item, which can be an arbitrary resource file that contains an icon (e.g. .ico, .exe, .dll).
|
|
273
|
-
* @property { number } iconIndex The index of the icon in the resource file. If a resource file contains multiple icons this value can be used to specify the zero-based index of the icon that should be displayed for this task. If a resource file contains only one icon, this property should be set to zero.
|
|
274
|
-
*/
|
|
275
203
|
/**
|
|
276
204
|
* Determines if the application is currently running.
|
|
277
205
|
*
|
|
@@ -856,19 +784,15 @@ declare class Application extends EmitterBase<OpenFin_2.ApplicationEvent> {
|
|
|
856
784
|
}
|
|
857
785
|
|
|
858
786
|
/**
|
|
859
|
-
*
|
|
860
|
-
* @interface
|
|
787
|
+
* @deprecated Renamed to {@link ConnectedEvent}.
|
|
861
788
|
*/
|
|
862
|
-
declare type ApplicationConnectedEvent =
|
|
863
|
-
topic: 'application';
|
|
864
|
-
type: 'connected';
|
|
865
|
-
};
|
|
789
|
+
declare type ApplicationConnectedEvent = ConnectedEvent_2;
|
|
866
790
|
|
|
867
791
|
/**
|
|
868
792
|
* Generated when an application is created.
|
|
869
793
|
* @interface
|
|
870
794
|
*/
|
|
871
|
-
declare type ApplicationCreatedEvent =
|
|
795
|
+
declare type ApplicationCreatedEvent = BaseEvent_8 & BaseEvents.IdentityEvent & {
|
|
872
796
|
type: 'application-created';
|
|
873
797
|
};
|
|
874
798
|
|
|
@@ -892,17 +816,15 @@ declare type ApplicationCreationOptions = Partial<ApplicationOptions> & {
|
|
|
892
816
|
};
|
|
893
817
|
|
|
894
818
|
/**
|
|
895
|
-
*
|
|
896
|
-
* discriminated by {@link ApplicationEvent.type | their type}. Event payloads unique to `Application` can be found
|
|
897
|
-
* under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
|
898
|
-
* from which they propagate).
|
|
819
|
+
* @deprecated Renamed to {@link Event}.
|
|
899
820
|
*/
|
|
900
|
-
declare type ApplicationEvent =
|
|
821
|
+
declare type ApplicationEvent = Event_3;
|
|
901
822
|
|
|
902
823
|
declare type ApplicationEvent_2 = Events.ApplicationEvents.ApplicationEvent;
|
|
903
824
|
|
|
904
825
|
declare namespace ApplicationEvents {
|
|
905
826
|
export {
|
|
827
|
+
BaseEvent_3 as BaseEvent,
|
|
906
828
|
BaseApplicationEvent,
|
|
907
829
|
CrashedEvent,
|
|
908
830
|
FileDownloadLocationChangedEvent,
|
|
@@ -916,6 +838,7 @@ declare namespace ApplicationEvents {
|
|
|
916
838
|
WindowStartLoadEvent,
|
|
917
839
|
ApplicationWindowEvent,
|
|
918
840
|
ClosedEvent,
|
|
841
|
+
ConnectedEvent_2 as ConnectedEvent,
|
|
919
842
|
ApplicationConnectedEvent,
|
|
920
843
|
InitializedEvent,
|
|
921
844
|
ManifestChangedEvent,
|
|
@@ -923,19 +846,24 @@ declare namespace ApplicationEvents {
|
|
|
923
846
|
RespondingEvent,
|
|
924
847
|
StartedEvent,
|
|
925
848
|
ApplicationSourcedEvent,
|
|
849
|
+
ApplicationSourcedEventType,
|
|
850
|
+
Event_3 as Event,
|
|
926
851
|
ApplicationEvent,
|
|
852
|
+
EventType_3 as EventType,
|
|
927
853
|
ApplicationEventType,
|
|
854
|
+
PropagatedEvent_4 as PropagatedEvent,
|
|
928
855
|
PropagatedApplicationEvent,
|
|
856
|
+
PropagatedEventType_3 as PropagatedEventType,
|
|
929
857
|
PropagatedApplicationEventType,
|
|
930
|
-
|
|
931
|
-
ByType
|
|
858
|
+
Payload_4 as Payload,
|
|
859
|
+
ByType_3 as ByType
|
|
932
860
|
}
|
|
933
861
|
}
|
|
934
862
|
|
|
935
863
|
/**
|
|
936
|
-
*
|
|
864
|
+
* @deprecated Renamed to {@link EventType}.
|
|
937
865
|
*/
|
|
938
|
-
declare type ApplicationEventType =
|
|
866
|
+
declare type ApplicationEventType = EventType_3;
|
|
939
867
|
|
|
940
868
|
declare type ApplicationIdentity = OpenFin_2.ApplicationIdentity;
|
|
941
869
|
|
|
@@ -1257,10 +1185,13 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1257
1185
|
*/
|
|
1258
1186
|
apiDiagnostics: boolean;
|
|
1259
1187
|
/**
|
|
1260
|
-
*
|
|
1261
|
-
* See [here](https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads) for more details.
|
|
1188
|
+
* @deprecated Please use {@link domainSettings} instead
|
|
1262
1189
|
*/
|
|
1263
1190
|
defaultDomainSettings: DefaultDomainSettings;
|
|
1191
|
+
/**
|
|
1192
|
+
* Define the {@link https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads file download rules} and domain-based api injection rules.
|
|
1193
|
+
*/
|
|
1194
|
+
domainSettings: DomainSettings;
|
|
1264
1195
|
/**
|
|
1265
1196
|
* @defaultValue false
|
|
1266
1197
|
*
|
|
@@ -1288,9 +1219,13 @@ declare type ApplicationPermissions = {
|
|
|
1288
1219
|
* A union of all events that emit natively on the `Application` topic, i.e. excluding those that propagate
|
|
1289
1220
|
* from {@link OpenFin.ViewEvents} or {@link OpenFin.WindowEvents}. Due to details in propagation prefixing rules,
|
|
1290
1221
|
* does not include {@link ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}.
|
|
1291
|
-
*
|
|
1292
1222
|
*/
|
|
1293
|
-
declare type ApplicationSourcedEvent = ClosedEvent |
|
|
1223
|
+
declare type ApplicationSourcedEvent = ClosedEvent | ConnectedEvent_2 | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent_2 | StartedEvent | TrayIconClickedEvent | FileDownloadLocationChangedEvent;
|
|
1224
|
+
|
|
1225
|
+
/**
|
|
1226
|
+
* Union of possible type values for an {@link ApplicationSourcedEvent}.
|
|
1227
|
+
*/
|
|
1228
|
+
declare type ApplicationSourcedEventType = ApplicationSourcedEvent['type'];
|
|
1294
1229
|
|
|
1295
1230
|
declare type ApplicationState = OpenFin_2.ApplicationState;
|
|
1296
1231
|
|
|
@@ -1598,7 +1533,7 @@ declare interface AuthorizationPayload {
|
|
|
1598
1533
|
* ```
|
|
1599
1534
|
* @interface
|
|
1600
1535
|
*/
|
|
1601
|
-
declare type AuthRequestedEvent =
|
|
1536
|
+
declare type AuthRequestedEvent = BaseEvent_5 & {
|
|
1602
1537
|
type: 'auth-requested';
|
|
1603
1538
|
authInfo: {
|
|
1604
1539
|
host: string;
|
|
@@ -1660,21 +1595,9 @@ declare class Base {
|
|
|
1660
1595
|
}
|
|
1661
1596
|
|
|
1662
1597
|
/**
|
|
1663
|
-
*
|
|
1664
|
-
* @interface
|
|
1665
|
-
*/
|
|
1666
|
-
declare type BaseApplicationEvent = NamedEvent & {
|
|
1667
|
-
topic: `application`;
|
|
1668
|
-
};
|
|
1669
|
-
|
|
1670
|
-
/**
|
|
1671
|
-
* A base Channel event.
|
|
1672
|
-
* @interface
|
|
1598
|
+
* @deprecated Renamed to {@link BaseEvent}.
|
|
1673
1599
|
*/
|
|
1674
|
-
declare type
|
|
1675
|
-
channelName: string;
|
|
1676
|
-
channelId: string;
|
|
1677
|
-
};
|
|
1600
|
+
declare type BaseApplicationEvent = BaseEvent_3;
|
|
1678
1601
|
|
|
1679
1602
|
/**
|
|
1680
1603
|
* @interface
|
|
@@ -1743,10 +1666,70 @@ declare type BaseEvent = {
|
|
|
1743
1666
|
type: string;
|
|
1744
1667
|
};
|
|
1745
1668
|
|
|
1746
|
-
|
|
1669
|
+
/**
|
|
1670
|
+
* A base Channel event.
|
|
1671
|
+
* @interface
|
|
1672
|
+
*/
|
|
1673
|
+
declare type BaseEvent_2 = NamedEvent & {
|
|
1674
|
+
channelName: string;
|
|
1675
|
+
channelId: string;
|
|
1676
|
+
};
|
|
1677
|
+
|
|
1678
|
+
/**
|
|
1679
|
+
* Base type for events emitting on the `application` topic
|
|
1680
|
+
* @interface
|
|
1681
|
+
*/
|
|
1682
|
+
declare type BaseEvent_3 = BaseEvents.NamedEvent & {
|
|
1683
|
+
topic: `application`;
|
|
1684
|
+
};
|
|
1685
|
+
|
|
1686
|
+
/**
|
|
1687
|
+
* Base type for events emitting on the `view` topic
|
|
1688
|
+
* @interface
|
|
1689
|
+
*/
|
|
1690
|
+
declare type BaseEvent_4 = BaseEvents.NamedEvent & {
|
|
1691
|
+
topic: 'view';
|
|
1692
|
+
target: OpenFin_2.Identity;
|
|
1693
|
+
};
|
|
1694
|
+
|
|
1695
|
+
/**
|
|
1696
|
+
* Base type for events emitting on the `window` topic
|
|
1697
|
+
* @interface
|
|
1698
|
+
*/
|
|
1699
|
+
declare type BaseEvent_5 = BaseEvents.NamedEvent & {
|
|
1700
|
+
topic: 'window';
|
|
1701
|
+
};
|
|
1702
|
+
|
|
1703
|
+
/**
|
|
1704
|
+
* Base type for events emitting on the `externalapplication` topic
|
|
1705
|
+
* @interface
|
|
1706
|
+
*/
|
|
1707
|
+
declare type BaseEvent_6 = BaseEvents.BaseEvent & {
|
|
1708
|
+
topic: 'externalapplication';
|
|
1709
|
+
};
|
|
1710
|
+
|
|
1711
|
+
/**
|
|
1712
|
+
* The base frame event.
|
|
1713
|
+
* @interface
|
|
1714
|
+
*/
|
|
1715
|
+
declare type BaseEvent_7 = NamedEvent & {
|
|
1716
|
+
entityType: 'iframe';
|
|
1717
|
+
frameName: string;
|
|
1718
|
+
};
|
|
1719
|
+
|
|
1720
|
+
/**
|
|
1721
|
+
* Base type for events emitting on the `system` topic
|
|
1722
|
+
* @interface
|
|
1723
|
+
*/
|
|
1724
|
+
declare type BaseEvent_8 = BaseEvents.BaseEvent & {
|
|
1725
|
+
topic: 'system';
|
|
1726
|
+
};
|
|
1727
|
+
|
|
1728
|
+
declare type BaseEvent_9 = Events.BaseEvents.BaseEvent;
|
|
1747
1729
|
|
|
1748
1730
|
declare namespace BaseEvents {
|
|
1749
1731
|
export {
|
|
1732
|
+
NotCloseRequested,
|
|
1750
1733
|
PropagatedEventType,
|
|
1751
1734
|
PropagatedEvent,
|
|
1752
1735
|
EventHandler,
|
|
@@ -1757,21 +1740,14 @@ declare namespace BaseEvents {
|
|
|
1757
1740
|
}
|
|
1758
1741
|
|
|
1759
1742
|
/**
|
|
1760
|
-
*
|
|
1761
|
-
* @interface
|
|
1743
|
+
* @deprecated Renamed to {@link BaseEvent}.
|
|
1762
1744
|
*/
|
|
1763
|
-
declare type BaseExternalApplicationEvent =
|
|
1764
|
-
topic: 'externalapplication';
|
|
1765
|
-
};
|
|
1745
|
+
declare type BaseExternalApplicationEvent = BaseEvent_6;
|
|
1766
1746
|
|
|
1767
1747
|
/**
|
|
1768
|
-
*
|
|
1769
|
-
* @interface
|
|
1748
|
+
* @deprecated Renamed to {@link BaseEvent}.
|
|
1770
1749
|
*/
|
|
1771
|
-
declare type BaseFrameEvent =
|
|
1772
|
-
entityType: 'iframe';
|
|
1773
|
-
frameName: string;
|
|
1774
|
-
};
|
|
1750
|
+
declare type BaseFrameEvent = BaseEvent_7;
|
|
1775
1751
|
|
|
1776
1752
|
declare type BaseLoadFailedEvent = NamedEvent & {
|
|
1777
1753
|
errorCode: number;
|
|
@@ -1780,35 +1756,20 @@ declare type BaseLoadFailedEvent = NamedEvent & {
|
|
|
1780
1756
|
isMainFrame: boolean;
|
|
1781
1757
|
};
|
|
1782
1758
|
|
|
1783
|
-
/**
|
|
1784
|
-
* Base type for events emitting on the `system` topic
|
|
1785
|
-
* @interface
|
|
1786
|
-
*/
|
|
1787
|
-
declare type BaseSystemEvent = BaseEvent & {
|
|
1788
|
-
topic: 'system';
|
|
1789
|
-
};
|
|
1790
|
-
|
|
1791
1759
|
declare type BaseUrlEvent = NamedEvent & {
|
|
1792
1760
|
type: 'url-changed';
|
|
1793
1761
|
url: string;
|
|
1794
1762
|
};
|
|
1795
1763
|
|
|
1796
1764
|
/**
|
|
1797
|
-
*
|
|
1798
|
-
* @interface
|
|
1765
|
+
* @deprecated Renamed to {@link BaseEvent}.
|
|
1799
1766
|
*/
|
|
1800
|
-
declare type BaseViewEvent =
|
|
1801
|
-
topic: 'view';
|
|
1802
|
-
target: OpenFin_2.Identity;
|
|
1803
|
-
};
|
|
1767
|
+
declare type BaseViewEvent = BaseEvent_4;
|
|
1804
1768
|
|
|
1805
1769
|
/**
|
|
1806
|
-
*
|
|
1807
|
-
* @interface
|
|
1770
|
+
* @deprecated Renamed to {@link BaseEvent}.
|
|
1808
1771
|
*/
|
|
1809
|
-
declare type BaseWindowEvent =
|
|
1810
|
-
topic: 'window';
|
|
1811
|
-
};
|
|
1772
|
+
declare type BaseWindowEvent = BaseEvent_5;
|
|
1812
1773
|
|
|
1813
1774
|
/**
|
|
1814
1775
|
* User decision of whether a Window or specific View should close when trying to prevent an unload.
|
|
@@ -1875,7 +1836,7 @@ declare type BoundsChangedEvent = BoundsChangeEvent & {
|
|
|
1875
1836
|
* A general bounds change event without event type.
|
|
1876
1837
|
* @interface
|
|
1877
1838
|
*/
|
|
1878
|
-
declare type BoundsChangeEvent =
|
|
1839
|
+
declare type BoundsChangeEvent = BaseEvent_5 & {
|
|
1879
1840
|
changeType: 0 | 1 | 2;
|
|
1880
1841
|
deferred: boolean;
|
|
1881
1842
|
height: number;
|
|
@@ -1947,76 +1908,76 @@ declare interface BrowserWindow {
|
|
|
1947
1908
|
}
|
|
1948
1909
|
|
|
1949
1910
|
/**
|
|
1950
|
-
* Extracts a single event type matching the given key from the {@link
|
|
1911
|
+
* Extracts a single event type matching the given key from the View {@link Event} union.
|
|
1951
1912
|
*
|
|
1952
1913
|
* Alias for {@link Payload}, which may read better in source.
|
|
1953
1914
|
*
|
|
1954
1915
|
* @typeParam Type String key specifying the event to extract
|
|
1955
1916
|
*/
|
|
1956
|
-
declare type ByType<Type extends
|
|
1917
|
+
declare type ByType<Type extends EventType> = Payload_2<Type>;
|
|
1957
1918
|
|
|
1958
1919
|
/**
|
|
1959
|
-
* Extracts a single event type matching the given key from the {@link
|
|
1920
|
+
* Extracts a single event type matching the given key from the Window {@link Event} union.
|
|
1960
1921
|
*
|
|
1961
1922
|
* Alias for {@link Payload}, which may read better in source.
|
|
1962
1923
|
*
|
|
1963
1924
|
* @typeParam Type String key specifying the event to extract
|
|
1964
1925
|
*/
|
|
1965
|
-
declare type ByType_2<Type extends
|
|
1926
|
+
declare type ByType_2<Type extends EventType_2> = Payload_3<Type>;
|
|
1966
1927
|
|
|
1967
1928
|
/**
|
|
1968
|
-
* Extracts a single event type matching the given key from the {@link
|
|
1929
|
+
* Extracts a single event type matching the given key from the Application {@link Event} union.
|
|
1969
1930
|
*
|
|
1970
1931
|
* Alias for {@link Payload}, which may read better in source.
|
|
1971
1932
|
*
|
|
1972
1933
|
* @typeParam Type String key specifying the event to extract
|
|
1973
1934
|
*/
|
|
1974
|
-
declare type ByType_3<Type extends
|
|
1935
|
+
declare type ByType_3<Type extends EventType_3> = Payload_4<Type>;
|
|
1975
1936
|
|
|
1976
1937
|
/**
|
|
1977
|
-
* Extracts a single event type matching the given key from the {@link
|
|
1938
|
+
* Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
|
|
1978
1939
|
*
|
|
1979
1940
|
* Alias for {@link Payload}, which may read better in source.
|
|
1980
1941
|
*
|
|
1981
1942
|
* @typeParam Type String key specifying the event to extract
|
|
1982
1943
|
*/
|
|
1983
|
-
declare type ByType_4<Type extends
|
|
1944
|
+
declare type ByType_4<Type extends EventType_4> = Payload_5<Type>;
|
|
1984
1945
|
|
|
1985
1946
|
/**
|
|
1986
|
-
* Extracts a single event type matching the given key from the {@link
|
|
1947
|
+
* Extracts a single event type matching the given key from the Frame {@link Event} union.
|
|
1987
1948
|
*
|
|
1988
1949
|
* Alias for {@link Payload}, which may read better in source.
|
|
1989
1950
|
*
|
|
1990
1951
|
* @typeParam Type String key specifying the event to extract
|
|
1991
1952
|
*/
|
|
1992
|
-
declare type ByType_5<Type extends
|
|
1953
|
+
declare type ByType_5<Type extends EventType_5> = Payload_6<Type>;
|
|
1993
1954
|
|
|
1994
1955
|
/**
|
|
1995
|
-
* Extracts a single event type matching the given key from the {@link
|
|
1956
|
+
* Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
|
|
1996
1957
|
*
|
|
1997
1958
|
* Alias for {@link Payload}, which may read better in source.
|
|
1998
1959
|
*
|
|
1999
1960
|
* @typeParam Type String key specifying the event to extract
|
|
2000
1961
|
*/
|
|
2001
|
-
declare type ByType_6<Type extends
|
|
1962
|
+
declare type ByType_6<Type extends EventType_6> = Payload_7<Type>;
|
|
2002
1963
|
|
|
2003
1964
|
/**
|
|
2004
|
-
* Extracts a single event type matching the given key from the {@link
|
|
1965
|
+
* Extracts a single event type matching the given key from the Platform {@link Event} union.
|
|
2005
1966
|
*
|
|
2006
1967
|
* Alias for {@link Payload}, which may read better in source.
|
|
2007
1968
|
*
|
|
2008
1969
|
* @typeParam Type String key specifying the event to extract
|
|
2009
1970
|
*/
|
|
2010
|
-
declare type ByType_7<Type extends
|
|
1971
|
+
declare type ByType_7<Type extends EventType_7> = Payload_8<Type>;
|
|
2011
1972
|
|
|
2012
1973
|
/**
|
|
2013
|
-
* Extracts a single event type matching the given key from the {@link
|
|
1974
|
+
* Extracts a single event type matching the given key from the System {@link Event} union.
|
|
2014
1975
|
*
|
|
2015
1976
|
* Alias for {@link Payload}, which may read better in source.
|
|
2016
1977
|
*
|
|
2017
1978
|
* @typeParam Type String key specifying the event to extract
|
|
2018
1979
|
*/
|
|
2019
|
-
declare type ByType_8<Type extends
|
|
1980
|
+
declare type ByType_8<Type extends EventType_8> = Payload_9<Type>;
|
|
2020
1981
|
|
|
2021
1982
|
/**
|
|
2022
1983
|
* Configuration for page capture.
|
|
@@ -2682,14 +2643,6 @@ declare type ChannelClientConnectionListener = (identity: ClientIdentity, connec
|
|
|
2682
2643
|
|
|
2683
2644
|
declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) => any;
|
|
2684
2645
|
|
|
2685
|
-
/**
|
|
2686
|
-
* Generated when a Channel client is connected.
|
|
2687
|
-
* @interface
|
|
2688
|
-
*/
|
|
2689
|
-
declare type ChannelConnectedEvent = BaseChannelEvent & {
|
|
2690
|
-
type: 'connected';
|
|
2691
|
-
};
|
|
2692
|
-
|
|
2693
2646
|
/**
|
|
2694
2647
|
* Options provided on a client connection to a channel.
|
|
2695
2648
|
*
|
|
@@ -2721,21 +2674,9 @@ declare type ChannelCreateOptions = {
|
|
|
2721
2674
|
};
|
|
2722
2675
|
|
|
2723
2676
|
/**
|
|
2724
|
-
*
|
|
2725
|
-
* @interface
|
|
2726
|
-
*/
|
|
2727
|
-
declare type ChannelDisconnectedEvent = BaseChannelEvent & {
|
|
2728
|
-
type: 'disconnected';
|
|
2729
|
-
};
|
|
2730
|
-
|
|
2731
|
-
/**
|
|
2732
|
-
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Channel}. Events are
|
|
2733
|
-
* discriminated by {@link ChannelEvent.type | their type}. Event payloads unique to `Channel` can be found
|
|
2734
|
-
* under the {@link OpenFin.ChannelEvents} namespace.
|
|
2677
|
+
* @deprecated Renamed to {@link Event}.
|
|
2735
2678
|
*/
|
|
2736
|
-
declare type ChannelEvent =
|
|
2737
|
-
topic: 'channel';
|
|
2738
|
-
} & (ChannelConnectedEvent | ChannelDisconnectedEvent);
|
|
2679
|
+
declare type ChannelEvent = Event_2;
|
|
2739
2680
|
|
|
2740
2681
|
declare type ChannelMiddleware = OpenFin_2.ChannelMiddleware;
|
|
2741
2682
|
|
|
@@ -3089,20 +3030,6 @@ declare type ClientInfo = Omit<ClientIdentity, 'isLocalEndpointId'> & {
|
|
|
3089
3030
|
connectionUrl: string;
|
|
3090
3031
|
};
|
|
3091
3032
|
|
|
3092
|
-
/**
|
|
3093
|
-
* @PORTED
|
|
3094
|
-
* WriteRequestType interface
|
|
3095
|
-
* @typedef { object } WriteRequestType@typedef { object } WriteRequestType
|
|
3096
|
-
* @property { string } data Data to be written
|
|
3097
|
-
* @property { string } [type] Clipboard Type
|
|
3098
|
-
*/
|
|
3099
|
-
/**
|
|
3100
|
-
* @PORTED
|
|
3101
|
-
* OpenFin.WriteAnyClipboardRequest interface
|
|
3102
|
-
* @typedef { object } OpenFin.WriteAnyClipboardRequest@typedef { object } OpenFin.WriteAnyClipboardRequest
|
|
3103
|
-
* @property { string } data Data to be written
|
|
3104
|
-
* @property { OpenFin.ClipboardSelectionType } [type] Clipboard Type defaults to 'clipboard', use 'selection' for linux
|
|
3105
|
-
*/
|
|
3106
3033
|
/**
|
|
3107
3034
|
* The Clipboard API allows reading and writing to the clipboard in multiple formats.
|
|
3108
3035
|
*
|
|
@@ -3270,11 +3197,19 @@ declare type ClipboardSelectionType = 'clipboard' | 'selection';
|
|
|
3270
3197
|
* Generated when an application is closed.
|
|
3271
3198
|
* @interface
|
|
3272
3199
|
*/
|
|
3273
|
-
declare type ClosedEvent = IdentityEvent & {
|
|
3200
|
+
declare type ClosedEvent = BaseEvents.IdentityEvent & {
|
|
3274
3201
|
topic: 'application';
|
|
3275
3202
|
type: 'closed';
|
|
3276
3203
|
};
|
|
3277
3204
|
|
|
3205
|
+
/**
|
|
3206
|
+
* Generated when a window has closed.
|
|
3207
|
+
* @interface
|
|
3208
|
+
*/
|
|
3209
|
+
declare type ClosedEvent_2 = BaseEvent_5 & {
|
|
3210
|
+
type: 'closed';
|
|
3211
|
+
};
|
|
3212
|
+
|
|
3278
3213
|
/**
|
|
3279
3214
|
* @interface
|
|
3280
3215
|
*/
|
|
@@ -3282,6 +3217,15 @@ declare type ClosedMenuResult = {
|
|
|
3282
3217
|
result: 'closed';
|
|
3283
3218
|
};
|
|
3284
3219
|
|
|
3220
|
+
/**
|
|
3221
|
+
* Generated when a window has been prevented from closing.
|
|
3222
|
+
* @remarks A window will be prevented from closing by default, either through the API or by a user when ‘close-requested’ has been subscribed to and the Window.close(force) flag is false.
|
|
3223
|
+
* @interface
|
|
3224
|
+
*/
|
|
3225
|
+
declare type CloseRequestedEvent = BaseEvent_5 & {
|
|
3226
|
+
type: 'close-requested';
|
|
3227
|
+
};
|
|
3228
|
+
|
|
3285
3229
|
/**
|
|
3286
3230
|
* @interface
|
|
3287
3231
|
*/
|
|
@@ -3328,6 +3272,14 @@ declare interface CloseWindowPayload {
|
|
|
3328
3272
|
};
|
|
3329
3273
|
}
|
|
3330
3274
|
|
|
3275
|
+
/**
|
|
3276
|
+
* Generated when a window has initiated the closing routine.
|
|
3277
|
+
* @interface
|
|
3278
|
+
*/
|
|
3279
|
+
declare type ClosingEvent = BaseEvent_5 & {
|
|
3280
|
+
type: 'closing';
|
|
3281
|
+
};
|
|
3282
|
+
|
|
3331
3283
|
/**
|
|
3332
3284
|
* A ColumnOrRow is used to manage the state of Column and Rows within an OpenFin Layout.
|
|
3333
3285
|
*/
|
|
@@ -3407,6 +3359,39 @@ declare type ConfigWithUuid = BaseConfig & {
|
|
|
3407
3359
|
uuid: string;
|
|
3408
3360
|
};
|
|
3409
3361
|
|
|
3362
|
+
/**
|
|
3363
|
+
* Generated when a Channel client is connected.
|
|
3364
|
+
* @interface
|
|
3365
|
+
*/
|
|
3366
|
+
declare type ConnectedEvent = BaseEvent_2 & {
|
|
3367
|
+
type: 'connected';
|
|
3368
|
+
};
|
|
3369
|
+
|
|
3370
|
+
/**
|
|
3371
|
+
* Generated when an application has authenticated and is connected.
|
|
3372
|
+
* @interface
|
|
3373
|
+
*/
|
|
3374
|
+
declare type ConnectedEvent_2 = BaseEvents.IdentityEvent & {
|
|
3375
|
+
topic: 'application';
|
|
3376
|
+
type: 'connected';
|
|
3377
|
+
};
|
|
3378
|
+
|
|
3379
|
+
/**
|
|
3380
|
+
* Generated when an external application has authenticated and is connected.
|
|
3381
|
+
* @interface
|
|
3382
|
+
*/
|
|
3383
|
+
declare type ConnectedEvent_3 = BaseExternalApplicationEvent & {
|
|
3384
|
+
type: 'connected';
|
|
3385
|
+
};
|
|
3386
|
+
|
|
3387
|
+
/**
|
|
3388
|
+
* Generated when a frame is connected.
|
|
3389
|
+
* @interface
|
|
3390
|
+
*/
|
|
3391
|
+
declare type ConnectedEvent_4 = BaseFrameEvent & {
|
|
3392
|
+
type: 'connected';
|
|
3393
|
+
};
|
|
3394
|
+
|
|
3410
3395
|
declare type Constructor<T = {}> = new () => T;
|
|
3411
3396
|
|
|
3412
3397
|
declare type ConstructorOverride<T> = (Base: Constructor<T>) => Constructor<T>;
|
|
@@ -3417,6 +3402,10 @@ declare type ConstructorOverride<T> = (Base: Constructor<T>) => Constructor<T>;
|
|
|
3417
3402
|
* @interface
|
|
3418
3403
|
*/
|
|
3419
3404
|
declare type ConstViewOptions = {
|
|
3405
|
+
/**
|
|
3406
|
+
* Configurations for API injection.
|
|
3407
|
+
*/
|
|
3408
|
+
api: Api;
|
|
3420
3409
|
/**
|
|
3421
3410
|
* The name of the view.
|
|
3422
3411
|
*/
|
|
@@ -3497,9 +3486,13 @@ declare type ConstViewOptions = {
|
|
|
3497
3486
|
/**
|
|
3498
3487
|
* Controls interaction of the view with its parent window's download shelf.
|
|
3499
3488
|
*/
|
|
3500
|
-
downloadShelf
|
|
3489
|
+
downloadShelf: {
|
|
3501
3490
|
/**
|
|
3502
|
-
* Whether downloads in this view trigger opening the download shelf on its parent BrowserWindow
|
|
3491
|
+
* Whether downloads in this view trigger opening the download shelf on its parent BrowserWindow.
|
|
3492
|
+
*
|
|
3493
|
+
* @remarks If `enabled: true`, downloads from this view will cause the download shelf to display
|
|
3494
|
+
* on the parent window even if that parent window's {@link DownloadShelfOptions} specify
|
|
3495
|
+
* `enabled: false`.
|
|
3503
3496
|
*/
|
|
3504
3497
|
enabled: boolean;
|
|
3505
3498
|
};
|
|
@@ -3565,7 +3558,7 @@ declare type ConstWindowOptions = {
|
|
|
3565
3558
|
/**
|
|
3566
3559
|
* @defaultValue true
|
|
3567
3560
|
*
|
|
3568
|
-
*
|
|
3561
|
+
* Setting this to false would keep the Window alive even if all its Views were closed.
|
|
3569
3562
|
* This is meant for advanced users and should be used with caution.
|
|
3570
3563
|
* Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
|
|
3571
3564
|
* Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
|
|
@@ -3575,7 +3568,8 @@ declare type ConstWindowOptions = {
|
|
|
3575
3568
|
/**
|
|
3576
3569
|
* @defaultValue 'all'
|
|
3577
3570
|
*
|
|
3578
|
-
*
|
|
3571
|
+
* When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
|
|
3572
|
+
+ * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
|
|
3579
3573
|
* **NOTE:** - This option is ignored in non-Platforms apps.
|
|
3580
3574
|
*/
|
|
3581
3575
|
viewsPreventingClose: 'all' | 'layout';
|
|
@@ -3614,6 +3608,12 @@ declare type ConstWindowOptions = {
|
|
|
3614
3608
|
* launches in favor of the cached value.
|
|
3615
3609
|
*/
|
|
3616
3610
|
defaultWidth: number;
|
|
3611
|
+
/**
|
|
3612
|
+
* Controls the styling and behavior of the window download shelf.
|
|
3613
|
+
*
|
|
3614
|
+
* @remarks This will control the styling for the download shelf regardless of whether its display was
|
|
3615
|
+
* triggered by the window itself, or a view targeting the window.
|
|
3616
|
+
*/
|
|
3617
3617
|
downloadShelf: DownloadShelfOptions;
|
|
3618
3618
|
height: number;
|
|
3619
3619
|
layout: any;
|
|
@@ -4148,7 +4148,7 @@ declare type Context_3 = {
|
|
|
4148
4148
|
* Generated when a window's context is updated via {@link Platform#setWindowContext Platform.setWindowContext}. Only available on windows in a Platform.
|
|
4149
4149
|
* @interface
|
|
4150
4150
|
*/
|
|
4151
|
-
declare type ContextChangedEvent =
|
|
4151
|
+
declare type ContextChangedEvent = BaseEvent_5 & {
|
|
4152
4152
|
type: 'context-changed';
|
|
4153
4153
|
context: any;
|
|
4154
4154
|
};
|
|
@@ -4300,7 +4300,7 @@ declare type CpuInfo = {
|
|
|
4300
4300
|
* Generated when an application has crashed.
|
|
4301
4301
|
* @interface
|
|
4302
4302
|
*/
|
|
4303
|
-
declare type CrashedEvent = IdentityEvent & {
|
|
4303
|
+
declare type CrashedEvent = BaseEvents.IdentityEvent & {
|
|
4304
4304
|
topic: 'application';
|
|
4305
4305
|
type: 'crashed';
|
|
4306
4306
|
reason: 'normal-termination' | 'abnormal-termination' | 'killed' | 'crashed' | 'still-running' | 'launch-failed' | 'out-of-memory' | 'integrity-failure';
|
|
@@ -4351,7 +4351,7 @@ declare type CrashReporterState = CrashReporterOptions & {
|
|
|
4351
4351
|
* Generated when a View is created.
|
|
4352
4352
|
* @interface
|
|
4353
4353
|
*/
|
|
4354
|
-
declare type CreatedEvent =
|
|
4354
|
+
declare type CreatedEvent = BaseEvent_4 & {
|
|
4355
4355
|
type: 'created';
|
|
4356
4356
|
};
|
|
4357
4357
|
|
|
@@ -4382,7 +4382,7 @@ declare type CreateViewPayload = {
|
|
|
4382
4382
|
/**
|
|
4383
4383
|
* @interface
|
|
4384
4384
|
*/
|
|
4385
|
-
declare type CreateViewTarget = LayoutIdentity & {
|
|
4385
|
+
declare type CreateViewTarget = (Identity_5 | LayoutIdentity) & {
|
|
4386
4386
|
/**
|
|
4387
4387
|
* If specified, view creation will not attach to a window and caller must
|
|
4388
4388
|
* insert the view into the layout explicitly
|
|
@@ -4451,21 +4451,15 @@ declare type CustomRequestHeaders = {
|
|
|
4451
4451
|
declare type DataChannelReadyState = RTCDataChannel['readyState'];
|
|
4452
4452
|
|
|
4453
4453
|
/**
|
|
4454
|
+
* @deprecated Use {@link OpenFin.DomainSettings} instead.
|
|
4454
4455
|
* @interface
|
|
4455
4456
|
*/
|
|
4456
|
-
declare type DefaultDomainSettings =
|
|
4457
|
-
rules: DefaultDomainSettingsRule[];
|
|
4458
|
-
};
|
|
4457
|
+
declare type DefaultDomainSettings = DomainSettings;
|
|
4459
4458
|
|
|
4460
4459
|
/**
|
|
4461
|
-
* @
|
|
4460
|
+
* @deprecated Use {@link OpenFin.DomainSettingsRule} instead.
|
|
4462
4461
|
*/
|
|
4463
|
-
declare type DefaultDomainSettingsRule =
|
|
4464
|
-
match: string[];
|
|
4465
|
-
options: {
|
|
4466
|
-
downloadSettings: FileDownloadSettings;
|
|
4467
|
-
};
|
|
4468
|
-
};
|
|
4462
|
+
declare type DefaultDomainSettingsRule = DomainSettingsRule;
|
|
4469
4463
|
|
|
4470
4464
|
declare interface DesktopAgent {
|
|
4471
4465
|
open(app: TargetApp, context?: Context): Promise<void>;
|
|
@@ -4510,7 +4504,7 @@ declare interface DesktopAgent_2 {
|
|
|
4510
4504
|
* Generated when the desktop icon is clicked while it's already running.
|
|
4511
4505
|
* @interface
|
|
4512
4506
|
*/
|
|
4513
|
-
declare type DesktopIconClickedEvent =
|
|
4507
|
+
declare type DesktopIconClickedEvent = BaseEvent_8 & {
|
|
4514
4508
|
type: 'desktop-icon-clicked';
|
|
4515
4509
|
};
|
|
4516
4510
|
|
|
@@ -4518,10 +4512,18 @@ declare type DesktopIconClickedEvent = BaseSystemEvent & {
|
|
|
4518
4512
|
* Generated when a View is destroyed.
|
|
4519
4513
|
* @interface
|
|
4520
4514
|
*/
|
|
4521
|
-
declare type DestroyedEvent =
|
|
4515
|
+
declare type DestroyedEvent = BaseEvent_4 & {
|
|
4522
4516
|
type: 'destroyed';
|
|
4523
4517
|
};
|
|
4524
4518
|
|
|
4519
|
+
/**
|
|
4520
|
+
* @interface
|
|
4521
|
+
*/
|
|
4522
|
+
declare type DeviceInfo = {
|
|
4523
|
+
vendorId: string | number;
|
|
4524
|
+
productId: string | number;
|
|
4525
|
+
};
|
|
4526
|
+
|
|
4525
4527
|
/**
|
|
4526
4528
|
* Generated when a page's theme color changes. This is usually due to encountering a meta tag.
|
|
4527
4529
|
* @interface
|
|
@@ -4619,21 +4621,45 @@ declare type DisabledMovementBoundsChangingEvent = BoundsChangeEvent & {
|
|
|
4619
4621
|
};
|
|
4620
4622
|
|
|
4621
4623
|
/**
|
|
4622
|
-
*
|
|
4623
|
-
*
|
|
4624
|
-
* this is their meaning.
|
|
4624
|
+
* Generated when a Channel client has disconnected.
|
|
4625
|
+
* @interface
|
|
4625
4626
|
*/
|
|
4626
|
-
declare
|
|
4627
|
-
|
|
4628
|
-
|
|
4629
|
-
|
|
4630
|
-
|
|
4631
|
-
|
|
4632
|
-
|
|
4633
|
-
|
|
4634
|
-
|
|
4635
|
-
|
|
4636
|
-
|
|
4627
|
+
declare type DisconnectedEvent = BaseEvent_2 & {
|
|
4628
|
+
type: 'disconnected';
|
|
4629
|
+
};
|
|
4630
|
+
|
|
4631
|
+
/**
|
|
4632
|
+
* Generated when an external application has disconnected.
|
|
4633
|
+
* @interface
|
|
4634
|
+
*/
|
|
4635
|
+
declare type DisconnectedEvent_2 = BaseExternalApplicationEvent & {
|
|
4636
|
+
type: 'disconnected';
|
|
4637
|
+
};
|
|
4638
|
+
|
|
4639
|
+
/**
|
|
4640
|
+
* Generated when a frame has disconnected.
|
|
4641
|
+
* @interface
|
|
4642
|
+
*/
|
|
4643
|
+
declare type DisconnectedEvent_3 = BaseFrameEvent & {
|
|
4644
|
+
type: 'disconnected';
|
|
4645
|
+
};
|
|
4646
|
+
|
|
4647
|
+
/**
|
|
4648
|
+
* A system channel will be global enough to have a presence across many apps. This gives us some hints
|
|
4649
|
+
* to render them in a standard way. It is assumed it may have other properties too, but if it has these,
|
|
4650
|
+
* this is their meaning.
|
|
4651
|
+
*/
|
|
4652
|
+
declare interface DisplayMetadata {
|
|
4653
|
+
/**
|
|
4654
|
+
* A user-readable name for this channel, e.g: `"Red"`
|
|
4655
|
+
*/
|
|
4656
|
+
readonly name?: string;
|
|
4657
|
+
/**
|
|
4658
|
+
* The color that should be associated within this channel when displaying this channel in a UI, e.g: `0xFF0000`.
|
|
4659
|
+
*/
|
|
4660
|
+
readonly color?: string;
|
|
4661
|
+
/**
|
|
4662
|
+
* A URL of an image that can be used to display this channel
|
|
4637
4663
|
*/
|
|
4638
4664
|
readonly glyph?: string;
|
|
4639
4665
|
}
|
|
@@ -4678,6 +4704,25 @@ declare type DisplayMetadata_3 = {
|
|
|
4678
4704
|
readonly glyph?: string;
|
|
4679
4705
|
};
|
|
4680
4706
|
|
|
4707
|
+
/**
|
|
4708
|
+
* @interface
|
|
4709
|
+
* Define the {@link https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads file download rules} and domain-based api injection rules.
|
|
4710
|
+
*/
|
|
4711
|
+
declare type DomainSettings = {
|
|
4712
|
+
rules: DomainSettingsRule[];
|
|
4713
|
+
};
|
|
4714
|
+
|
|
4715
|
+
/**
|
|
4716
|
+
* @interface
|
|
4717
|
+
*/
|
|
4718
|
+
declare type DomainSettingsRule = {
|
|
4719
|
+
match: string[];
|
|
4720
|
+
options: {
|
|
4721
|
+
downloadSettings?: FileDownloadSettings;
|
|
4722
|
+
api?: ApiInjection;
|
|
4723
|
+
};
|
|
4724
|
+
};
|
|
4725
|
+
|
|
4681
4726
|
/**
|
|
4682
4727
|
* Metadata returned from a preload script download request.
|
|
4683
4728
|
*
|
|
@@ -4722,14 +4767,24 @@ declare type DownloadRule = {
|
|
|
4722
4767
|
* @interface
|
|
4723
4768
|
*
|
|
4724
4769
|
* Controls the styling and behavior of the window download shelf.
|
|
4770
|
+
*
|
|
4771
|
+
* @remarks This will control the styling for the download shelf regardless of whether its display was
|
|
4772
|
+
* triggered by the window itself, or a view targeting the window.
|
|
4725
4773
|
*/
|
|
4726
4774
|
declare type DownloadShelfOptions = {
|
|
4727
4775
|
/**
|
|
4728
|
-
* Whether downloads in this window trigger
|
|
4776
|
+
* Whether downloads in this window trigger display of the download shelf.
|
|
4777
|
+
*
|
|
4778
|
+
* @remarks Setting this to false will *not* prevent the download shelf from opening if a child view
|
|
4779
|
+
* with `downloadShelf: { enabled: true }` initiates a download.
|
|
4729
4780
|
*/
|
|
4730
4781
|
enabled: boolean;
|
|
4731
4782
|
/**
|
|
4732
4783
|
* Styling options for the download shelf border.
|
|
4784
|
+
*
|
|
4785
|
+
* @remarks These apply regardless of whether download shelf display was
|
|
4786
|
+
* triggered by this window itself, or a view targeting the window. Individual views
|
|
4787
|
+
* cannot control the rendering of their parent window's download shelf.
|
|
4733
4788
|
*/
|
|
4734
4789
|
border?: {
|
|
4735
4790
|
/**
|
|
@@ -4739,7 +4794,7 @@ declare type DownloadShelfOptions = {
|
|
|
4739
4794
|
*/
|
|
4740
4795
|
size?: number;
|
|
4741
4796
|
/**
|
|
4742
|
-
* Color of the border
|
|
4797
|
+
* Color of the border. Must be a 6-character hex code prefixed by #. Defaults to chromium theme
|
|
4743
4798
|
* if absent.
|
|
4744
4799
|
*/
|
|
4745
4800
|
color?: string;
|
|
@@ -4751,7 +4806,7 @@ declare type DownloadShelfOptions = {
|
|
|
4751
4806
|
*
|
|
4752
4807
|
* @interface
|
|
4753
4808
|
*/
|
|
4754
|
-
declare type DownloadShelfVisibilityChangedEvent =
|
|
4809
|
+
declare type DownloadShelfVisibilityChangedEvent = BaseEvent_5 & {
|
|
4755
4810
|
type: 'download-shelf-visibility-changed';
|
|
4756
4811
|
/**
|
|
4757
4812
|
* True if the download shelf was just opened; false if it was just closed.
|
|
@@ -4781,7 +4836,7 @@ declare interface DragSource {}
|
|
|
4781
4836
|
* Generated when a window has been embedded.
|
|
4782
4837
|
* @interface
|
|
4783
4838
|
*/
|
|
4784
|
-
declare type EmbeddedEvent =
|
|
4839
|
+
declare type EmbeddedEvent = BaseEvent_5 & {
|
|
4785
4840
|
type: 'embedded';
|
|
4786
4841
|
};
|
|
4787
4842
|
|
|
@@ -4880,7 +4935,7 @@ declare class EmitterMap {
|
|
|
4880
4935
|
* Generated when a window ends loading.
|
|
4881
4936
|
* @interface
|
|
4882
4937
|
*/
|
|
4883
|
-
declare type EndLoadEvent =
|
|
4938
|
+
declare type EndLoadEvent = BaseEvent_5 & {
|
|
4884
4939
|
type: 'end-load';
|
|
4885
4940
|
documentName: string;
|
|
4886
4941
|
isMain: boolean;
|
|
@@ -4958,9 +5013,10 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
|
|
|
4958
5013
|
} : never;
|
|
4959
5014
|
|
|
4960
5015
|
declare interface Environment {
|
|
4961
|
-
|
|
5016
|
+
initLayoutManager(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, wire: Transport, options: OpenFin_2.InitLayoutOptions): Promise<OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>>;
|
|
4962
5017
|
createLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, options: OpenFin_2.CreateLayoutOptions): Promise<void>;
|
|
4963
5018
|
destroyLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<void>;
|
|
5019
|
+
resolveLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<any>;
|
|
4964
5020
|
initPlatform(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, ...args: Parameters<OpenFin_2.Fin['Platform']['init']>): ReturnType<OpenFin_2.Fin['Platform']['init']>;
|
|
4965
5021
|
observeBounds(element: Element, onChange: (bounds: DOMRect) => Promise<void> | void): () => void;
|
|
4966
5022
|
writeToken(path: string, token: string): Promise<string>;
|
|
@@ -4997,6 +5053,88 @@ declare type ErrorPlainObject = {
|
|
|
4997
5053
|
toString(): string;
|
|
4998
5054
|
};
|
|
4999
5055
|
|
|
5056
|
+
/**
|
|
5057
|
+
* [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
|
|
5058
|
+
* discriminated by {@link Event.type | their type}. Event payloads unique to `Platform` can be found
|
|
5059
|
+
* under the {@link OpenFin.PlatformEvents} namespace.
|
|
5060
|
+
*/
|
|
5061
|
+
declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotAppliedEvent;
|
|
5062
|
+
|
|
5063
|
+
/**
|
|
5064
|
+
* [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
|
|
5065
|
+
* discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
|
|
5066
|
+
* under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
|
5067
|
+
* from which they propagate).
|
|
5068
|
+
*/
|
|
5069
|
+
declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
|
|
5070
|
+
|
|
5071
|
+
/**
|
|
5072
|
+
* [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
|
|
5073
|
+
* discriminated by {@link Event.type | their type}. Event payloads unique to `Channel` can be found
|
|
5074
|
+
* under the {@link OpenFin.ChannelEvents} namespace.
|
|
5075
|
+
*/
|
|
5076
|
+
declare type Event_2 = {
|
|
5077
|
+
topic: 'channel';
|
|
5078
|
+
} & (ConnectedEvent | DisconnectedEvent);
|
|
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 an {@link Application}. Events are
|
|
5082
|
+
* discriminated by {@link Event.type | their type}. Event payloads unique to `Application` can be found
|
|
5083
|
+
* under the {@link OpenFin.ApplicationEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
|
5084
|
+
* from which they propagate).
|
|
5085
|
+
*/
|
|
5086
|
+
declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.PropagatedEvent<'application'> | ApplicationWindowEvent | ApplicationSourcedEvent;
|
|
5087
|
+
|
|
5088
|
+
/**
|
|
5089
|
+
* [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
|
|
5090
|
+
* discriminated by {@link Event.type | their type}. Event payloads unique to `View` can be found
|
|
5091
|
+
* under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
|
|
5092
|
+
*/
|
|
5093
|
+
declare type Event_4 = (WebContentsEvents.Event<'view'> & {
|
|
5094
|
+
target: OpenFin_2.Identity;
|
|
5095
|
+
}) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
|
|
5096
|
+
|
|
5097
|
+
/**
|
|
5098
|
+
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
|
|
5099
|
+
* (i.e. {@link OpenFin.Window} or {@link OpenFin.View}).
|
|
5100
|
+
*/
|
|
5101
|
+
declare type Event_5<Topic extends string> = {
|
|
5102
|
+
topic: Topic;
|
|
5103
|
+
} & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent);
|
|
5104
|
+
|
|
5105
|
+
/**
|
|
5106
|
+
* [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
|
|
5107
|
+
* discriminated by {@link Event.type | their type}. Event payloads unique to `Window` can be found
|
|
5108
|
+
* under the {@link OpenFin.WindowEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
|
|
5109
|
+
*/
|
|
5110
|
+
declare type Event_6 = WindowSourcedEvent | WindowViewEvent | ViewEvents.PropagatedEvent<'window'>;
|
|
5111
|
+
|
|
5112
|
+
/**
|
|
5113
|
+
* [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
|
|
5114
|
+
* discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
|
|
5115
|
+
* under the {@link OpenFin.ExternalApplicationEvents} namespace.
|
|
5116
|
+
*/
|
|
5117
|
+
declare type Event_7 = ConnectedEvent_3 | DisconnectedEvent_2;
|
|
5118
|
+
|
|
5119
|
+
/**
|
|
5120
|
+
* [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
|
|
5121
|
+
* discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
|
|
5122
|
+
* under the {@link OpenFin.FrameEvents} namespace.
|
|
5123
|
+
*/
|
|
5124
|
+
declare type Event_8 = {
|
|
5125
|
+
topic: 'frame';
|
|
5126
|
+
} & (ConnectedEvent_4 | DisconnectedEvent_3);
|
|
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 {@link GlobalHotkey}. Events are
|
|
5130
|
+
* discriminated by {@link Event.type | their type}. Event payloads unique to `GlobalHotkey` can be found
|
|
5131
|
+
* under the {@link OpenFin.GlobalHotkeyEvents} namespace.
|
|
5132
|
+
*/
|
|
5133
|
+
declare type Event_9 = {
|
|
5134
|
+
topic: 'global-hotkey';
|
|
5135
|
+
hotkey: 'string';
|
|
5136
|
+
} & (RegisteredEvent | UnregisteredEvent);
|
|
5137
|
+
|
|
5000
5138
|
declare class EventAggregator extends EmitterMap {
|
|
5001
5139
|
dispatchEvent: (message: Message<any>) => boolean;
|
|
5002
5140
|
}
|
|
@@ -5062,6 +5200,46 @@ declare namespace Events {
|
|
|
5062
5200
|
}
|
|
5063
5201
|
}
|
|
5064
5202
|
|
|
5203
|
+
/**
|
|
5204
|
+
* Union of possible `type` values for a view {@link Event}.
|
|
5205
|
+
*/
|
|
5206
|
+
declare type EventType = Event_4['type'];
|
|
5207
|
+
|
|
5208
|
+
/**
|
|
5209
|
+
* Union of possible `type` values for a Window {@link Event}.
|
|
5210
|
+
*/
|
|
5211
|
+
declare type EventType_2 = Event_6['type'];
|
|
5212
|
+
|
|
5213
|
+
/**
|
|
5214
|
+
* Union of possible `type` values for an Application {@link Event}.
|
|
5215
|
+
*/
|
|
5216
|
+
declare type EventType_3 = Event_3['type'];
|
|
5217
|
+
|
|
5218
|
+
/**
|
|
5219
|
+
* Union of possible `type` values for an ExternalApplication {@link Event}.
|
|
5220
|
+
*/
|
|
5221
|
+
declare type EventType_4 = Event_7['type'];
|
|
5222
|
+
|
|
5223
|
+
/**
|
|
5224
|
+
* Union of possible `type` values for a {@link FrameEvent}.
|
|
5225
|
+
*/
|
|
5226
|
+
declare type EventType_5 = Event_8['type'];
|
|
5227
|
+
|
|
5228
|
+
/**
|
|
5229
|
+
* Union of possible `type` values for a {@link GlobalHotkeyEvent}
|
|
5230
|
+
*/
|
|
5231
|
+
declare type EventType_6 = Event_9['type'];
|
|
5232
|
+
|
|
5233
|
+
/**
|
|
5234
|
+
* Union of possible `type` values for a {@link PlatformEvent}.
|
|
5235
|
+
*/
|
|
5236
|
+
declare type EventType_7 = Event_10['type'];
|
|
5237
|
+
|
|
5238
|
+
/**
|
|
5239
|
+
* Union of possible `type` values for a {@link SystemEvent}.
|
|
5240
|
+
*/
|
|
5241
|
+
declare type EventType_8 = Event_11['type'];
|
|
5242
|
+
|
|
5065
5243
|
/* Excluded from this release type: EventWithId */
|
|
5066
5244
|
|
|
5067
5245
|
/* Excluded from this release type: ExcludeRequested */
|
|
@@ -5092,83 +5270,6 @@ declare type ExitCode = {
|
|
|
5092
5270
|
declare class ExternalApplication extends EmitterBase<OpenFin_2.ExternalApplicationEvent> {
|
|
5093
5271
|
identity: OpenFin_2.ApplicationIdentity;
|
|
5094
5272
|
/* Excluded from this release type: __constructor */
|
|
5095
|
-
/**
|
|
5096
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
|
5097
|
-
* @param eventType - The type of the event.
|
|
5098
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
|
5099
|
-
* @param options - Option to support event timestamps.
|
|
5100
|
-
*
|
|
5101
|
-
* @function addListener
|
|
5102
|
-
* @memberof ExternalApplication
|
|
5103
|
-
* @instance
|
|
5104
|
-
* @tutorial ExternalApplication.EventEmitter
|
|
5105
|
-
*/
|
|
5106
|
-
/**
|
|
5107
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
|
5108
|
-
* @param eventType - The type of the event.
|
|
5109
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
|
5110
|
-
* @param options - Option to support event timestamps.
|
|
5111
|
-
*
|
|
5112
|
-
* @function on
|
|
5113
|
-
* @memberof ExternalApplication
|
|
5114
|
-
* @instance
|
|
5115
|
-
* @tutorial ExternalApplication.EventEmitter
|
|
5116
|
-
*/
|
|
5117
|
-
/**
|
|
5118
|
-
* Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
|
|
5119
|
-
* @param eventType - The type of the event.
|
|
5120
|
-
* @param listener - The callback function.
|
|
5121
|
-
* @param options - Option to support event timestamps.
|
|
5122
|
-
*
|
|
5123
|
-
* @function once
|
|
5124
|
-
* @memberof ExternalApplication
|
|
5125
|
-
* @instance
|
|
5126
|
-
* @tutorial ExternalApplication.EventEmitter
|
|
5127
|
-
*/
|
|
5128
|
-
/**
|
|
5129
|
-
* Adds a listener to the beginning of the listeners array for the specified event.
|
|
5130
|
-
* @param eventType - The type of the event.
|
|
5131
|
-
* @param listener - The callback function.
|
|
5132
|
-
* @param options - Option to support event timestamps.
|
|
5133
|
-
*
|
|
5134
|
-
* @function prependListener
|
|
5135
|
-
* @memberof ExternalApplication
|
|
5136
|
-
* @instance
|
|
5137
|
-
* @tutorial ExternalApplication.EventEmitter
|
|
5138
|
-
*/
|
|
5139
|
-
/**
|
|
5140
|
-
* Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
|
|
5141
|
-
* The listener is added to the beginning of the listeners array.
|
|
5142
|
-
* @param eventType - The type of the event.
|
|
5143
|
-
* @param listener - The callback function.
|
|
5144
|
-
* @param options - Option to support event timestamps.
|
|
5145
|
-
*
|
|
5146
|
-
* @function prependOnceListener
|
|
5147
|
-
* @memberof ExternalApplication
|
|
5148
|
-
* @instance
|
|
5149
|
-
* @tutorial ExternalApplication.EventEmitter
|
|
5150
|
-
*/
|
|
5151
|
-
/**
|
|
5152
|
-
* Remove a listener from the listener array for the specified event.
|
|
5153
|
-
* Caution: Calling this method changes the array indices in the listener array behind the listener.
|
|
5154
|
-
* @param eventType - The type of the event.
|
|
5155
|
-
* @param listener - The callback function.
|
|
5156
|
-
* @param options - Option to support event timestamps.
|
|
5157
|
-
*
|
|
5158
|
-
* @function removeListener
|
|
5159
|
-
* @memberof ExternalApplication
|
|
5160
|
-
* @instance
|
|
5161
|
-
* @tutorial ExternalApplication.EventEmitter
|
|
5162
|
-
*/
|
|
5163
|
-
/**
|
|
5164
|
-
* Removes all listeners, or those of the specified event.
|
|
5165
|
-
* @param eventType - The type of the event.
|
|
5166
|
-
*
|
|
5167
|
-
* @function removeAllListeners
|
|
5168
|
-
* @memberof ExternalApplication
|
|
5169
|
-
* @instance
|
|
5170
|
-
* @tutorial ExternalApplication.EventEmitter
|
|
5171
|
-
*/
|
|
5172
5273
|
/**
|
|
5173
5274
|
* Retrieves information about the external application.
|
|
5174
5275
|
*
|
|
@@ -5185,46 +5286,43 @@ declare class ExternalApplication extends EmitterBase<OpenFin_2.ExternalApplicat
|
|
|
5185
5286
|
}
|
|
5186
5287
|
|
|
5187
5288
|
/**
|
|
5188
|
-
*
|
|
5189
|
-
* @interface
|
|
5289
|
+
* @deprecated Renamed to {@link ConnectedEvent}.
|
|
5190
5290
|
*/
|
|
5191
|
-
declare type ExternalApplicationConnectedEvent =
|
|
5192
|
-
type: 'connected';
|
|
5193
|
-
};
|
|
5291
|
+
declare type ExternalApplicationConnectedEvent = ConnectedEvent_3;
|
|
5194
5292
|
|
|
5195
5293
|
/**
|
|
5196
|
-
*
|
|
5197
|
-
* @interface
|
|
5294
|
+
* @deprecated Renamed to {@link DisconnectedEvent}.
|
|
5198
5295
|
*/
|
|
5199
|
-
declare type ExternalApplicationDisconnectedEvent =
|
|
5200
|
-
type: 'disconnected';
|
|
5201
|
-
};
|
|
5296
|
+
declare type ExternalApplicationDisconnectedEvent = DisconnectedEvent_2;
|
|
5202
5297
|
|
|
5203
5298
|
/**
|
|
5204
|
-
*
|
|
5205
|
-
* discriminated by {@link ExternalApplicationEvent.type | their type}. Event payloads unique to `ExternalApplication` can be found
|
|
5206
|
-
* under the {@link OpenFin.ExternalApplicationEvents} namespace.
|
|
5299
|
+
* @deprecated Renamed to {@link Event}.
|
|
5207
5300
|
*/
|
|
5208
|
-
declare type ExternalApplicationEvent =
|
|
5301
|
+
declare type ExternalApplicationEvent = Event_7;
|
|
5209
5302
|
|
|
5210
5303
|
declare type ExternalApplicationEvent_2 = Events.ExternalApplicationEvents.ExternalApplicationEvent;
|
|
5211
5304
|
|
|
5212
5305
|
declare namespace ExternalApplicationEvents {
|
|
5213
5306
|
export {
|
|
5307
|
+
BaseEvent_6 as BaseEvent,
|
|
5214
5308
|
BaseExternalApplicationEvent,
|
|
5309
|
+
ConnectedEvent_3 as ConnectedEvent,
|
|
5215
5310
|
ExternalApplicationConnectedEvent,
|
|
5311
|
+
DisconnectedEvent_2 as DisconnectedEvent,
|
|
5216
5312
|
ExternalApplicationDisconnectedEvent,
|
|
5313
|
+
Event_7 as Event,
|
|
5217
5314
|
ExternalApplicationEvent,
|
|
5315
|
+
EventType_4 as EventType,
|
|
5218
5316
|
ExternalApplicationEventType,
|
|
5219
|
-
|
|
5220
|
-
|
|
5317
|
+
Payload_5 as Payload,
|
|
5318
|
+
ByType_4 as ByType
|
|
5221
5319
|
}
|
|
5222
5320
|
}
|
|
5223
5321
|
|
|
5224
5322
|
/**
|
|
5225
|
-
*
|
|
5323
|
+
* @deprecated Renamed to {@link Event}.
|
|
5226
5324
|
*/
|
|
5227
|
-
declare type ExternalApplicationEventType =
|
|
5325
|
+
declare type ExternalApplicationEventType = EventType_4;
|
|
5228
5326
|
|
|
5229
5327
|
/**
|
|
5230
5328
|
* @interface
|
|
@@ -5285,7 +5383,7 @@ declare type ExternalConnection = {
|
|
|
5285
5383
|
* Generated when an external process has exited.
|
|
5286
5384
|
* @interface
|
|
5287
5385
|
*/
|
|
5288
|
-
declare type ExternalProcessExitedEvent =
|
|
5386
|
+
declare type ExternalProcessExitedEvent = BaseEvent_5 & {
|
|
5289
5387
|
type: 'external-process-exited';
|
|
5290
5388
|
processUuid: string;
|
|
5291
5389
|
exitCode: number;
|
|
@@ -5330,19 +5428,15 @@ declare type ExternalProcessRequestType = {
|
|
|
5330
5428
|
* Generated when an external process has started.
|
|
5331
5429
|
* @interface
|
|
5332
5430
|
*/
|
|
5333
|
-
declare type ExternalProcessStartedEvent =
|
|
5431
|
+
declare type ExternalProcessStartedEvent = BaseEvent_5 & {
|
|
5334
5432
|
type: 'external-process-started';
|
|
5335
5433
|
processUuid: string;
|
|
5336
5434
|
};
|
|
5337
5435
|
|
|
5338
5436
|
/**
|
|
5339
|
-
*
|
|
5340
|
-
* @interface
|
|
5437
|
+
* @deprecated, use {@link PageFaviconUpdatedEvent}.
|
|
5341
5438
|
*/
|
|
5342
|
-
declare type FaviconUpdatedEvent =
|
|
5343
|
-
type: 'page-favicon-updated';
|
|
5344
|
-
favicons: string[];
|
|
5345
|
-
};
|
|
5439
|
+
declare type FaviconUpdatedEvent = PageFaviconUpdatedEvent;
|
|
5346
5440
|
|
|
5347
5441
|
declare namespace FDC3 {
|
|
5348
5442
|
export {
|
|
@@ -5429,7 +5523,7 @@ declare type FileDownloadEvent = {
|
|
|
5429
5523
|
*
|
|
5430
5524
|
* @interface
|
|
5431
5525
|
*/
|
|
5432
|
-
declare type FileDownloadLocationChangedEvent =
|
|
5526
|
+
declare type FileDownloadLocationChangedEvent = BaseEvent_3 & {
|
|
5433
5527
|
type: 'file-download-location-changed';
|
|
5434
5528
|
};
|
|
5435
5529
|
|
|
@@ -5591,83 +5685,6 @@ declare type FoundInPageEvent = NamedEvent & {
|
|
|
5591
5685
|
declare class _Frame extends EmitterBase<OpenFin_2.FrameEvent> {
|
|
5592
5686
|
identity: OpenFin_2.Identity;
|
|
5593
5687
|
/* Excluded from this release type: __constructor */
|
|
5594
|
-
/**
|
|
5595
|
-
* Adds the listener function to the end of the listeners array for the specified event type.
|
|
5596
|
-
* @param eventType - The type of the event.
|
|
5597
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
|
5598
|
-
* @param options - Option to support event timestamps.
|
|
5599
|
-
*
|
|
5600
|
-
* @function addListener
|
|
5601
|
-
* @memberof Frame
|
|
5602
|
-
* @instance
|
|
5603
|
-
* @tutorial Frame.EventEmitter
|
|
5604
|
-
*/
|
|
5605
|
-
/**
|
|
5606
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
|
5607
|
-
* @param eventType - The type of the event.
|
|
5608
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
|
5609
|
-
* @param options - Option to support event timestamps.
|
|
5610
|
-
*
|
|
5611
|
-
* @function on
|
|
5612
|
-
* @memberof Frame
|
|
5613
|
-
* @instance
|
|
5614
|
-
* @tutorial Frame.EventEmitter
|
|
5615
|
-
*/
|
|
5616
|
-
/**
|
|
5617
|
-
* Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
|
|
5618
|
-
* @param eventType - The type of the event.
|
|
5619
|
-
* @param listener - The callback function.
|
|
5620
|
-
* @param options - Option to support event timestamps.
|
|
5621
|
-
*
|
|
5622
|
-
* @function once
|
|
5623
|
-
* @memberof Frame
|
|
5624
|
-
* @instance
|
|
5625
|
-
* @tutorial Frame.EventEmitter
|
|
5626
|
-
*/
|
|
5627
|
-
/**
|
|
5628
|
-
* Adds a listener to the beginning of the listeners array for the specified event.
|
|
5629
|
-
* @param eventType - The type of the event.
|
|
5630
|
-
* @param listener - The callback function.
|
|
5631
|
-
* @param options - Option to support event timestamps.
|
|
5632
|
-
*
|
|
5633
|
-
* @function prependListener
|
|
5634
|
-
* @memberof Frame
|
|
5635
|
-
* @instance
|
|
5636
|
-
* @tutorial Frame.EventEmitter
|
|
5637
|
-
*/
|
|
5638
|
-
/**
|
|
5639
|
-
* Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
|
|
5640
|
-
* The listener is added to the beginning of the listeners array.
|
|
5641
|
-
* @param eventType - The type of the event.
|
|
5642
|
-
* @param listener - The callback function.
|
|
5643
|
-
* @param options - Option to support event timestamps.
|
|
5644
|
-
*
|
|
5645
|
-
* @function prependOnceListener
|
|
5646
|
-
* @memberof Frame
|
|
5647
|
-
* @instance
|
|
5648
|
-
* @tutorial Frame.EventEmitter
|
|
5649
|
-
*/
|
|
5650
|
-
/**
|
|
5651
|
-
* Remove a listener from the listener array for the specified event.
|
|
5652
|
-
* Caution: Calling this method changes the array indices in the listener array behind the listener.
|
|
5653
|
-
* @param eventType - The type of the event.
|
|
5654
|
-
* @param listener - The callback function.
|
|
5655
|
-
* @param options - Option to support event timestamps.
|
|
5656
|
-
*
|
|
5657
|
-
* @function removeListener
|
|
5658
|
-
* @memberof Frame
|
|
5659
|
-
* @instance
|
|
5660
|
-
* @tutorial Frame.EventEmitter
|
|
5661
|
-
*/
|
|
5662
|
-
/**
|
|
5663
|
-
* Removes all listeners, or those of the specified event.
|
|
5664
|
-
* @param eventType - The type of the event.
|
|
5665
|
-
*
|
|
5666
|
-
* @function removeAllListeners
|
|
5667
|
-
* @memberof Frame
|
|
5668
|
-
* @instance
|
|
5669
|
-
* @tutorial Frame.EventEmitter
|
|
5670
|
-
*/
|
|
5671
5688
|
/**
|
|
5672
5689
|
* Returns a frame info object for the represented frame.
|
|
5673
5690
|
*
|
|
@@ -5698,48 +5715,43 @@ declare class _Frame extends EmitterBase<OpenFin_2.FrameEvent> {
|
|
|
5698
5715
|
}
|
|
5699
5716
|
|
|
5700
5717
|
/**
|
|
5701
|
-
*
|
|
5702
|
-
* @interface
|
|
5718
|
+
* @deprecated Renamed to {@link ConnectedEvent}.
|
|
5703
5719
|
*/
|
|
5704
|
-
declare type FrameConnectedEvent =
|
|
5705
|
-
type: 'connected';
|
|
5706
|
-
};
|
|
5720
|
+
declare type FrameConnectedEvent = ConnectedEvent_4;
|
|
5707
5721
|
|
|
5708
5722
|
/**
|
|
5709
|
-
*
|
|
5710
|
-
* @interface
|
|
5723
|
+
* @deprecated Renamed to {@link DisconnectedEvent}.
|
|
5711
5724
|
*/
|
|
5712
|
-
declare type FrameDisconnectedEvent =
|
|
5713
|
-
type: 'disconnected';
|
|
5714
|
-
};
|
|
5725
|
+
declare type FrameDisconnectedEvent = DisconnectedEvent_3;
|
|
5715
5726
|
|
|
5716
5727
|
/**
|
|
5717
|
-
*
|
|
5718
|
-
* discriminated by {@link _Frame.type | their type}. Event payloads unique to `Frame` can be found
|
|
5719
|
-
* under the {@link OpenFin.FrameEvents} namespace.
|
|
5728
|
+
* @deprecated Renamed to {@link Event}.
|
|
5720
5729
|
*/
|
|
5721
|
-
declare type FrameEvent =
|
|
5722
|
-
topic: 'frame';
|
|
5723
|
-
} & (FrameConnectedEvent | FrameDisconnectedEvent);
|
|
5730
|
+
declare type FrameEvent = Event_8;
|
|
5724
5731
|
|
|
5725
5732
|
declare type FrameEvent_2 = Events.FrameEvents.FrameEvent;
|
|
5726
5733
|
|
|
5727
5734
|
declare namespace FrameEvents {
|
|
5728
5735
|
export {
|
|
5736
|
+
BaseEvent_7 as BaseEvent,
|
|
5729
5737
|
BaseFrameEvent,
|
|
5738
|
+
ConnectedEvent_4 as ConnectedEvent,
|
|
5730
5739
|
FrameConnectedEvent,
|
|
5740
|
+
DisconnectedEvent_3 as DisconnectedEvent,
|
|
5731
5741
|
FrameDisconnectedEvent,
|
|
5742
|
+
Event_8 as Event,
|
|
5732
5743
|
FrameEvent,
|
|
5744
|
+
EventType_5 as EventType,
|
|
5733
5745
|
FrameEventType,
|
|
5734
|
-
|
|
5735
|
-
|
|
5746
|
+
Payload_6 as Payload,
|
|
5747
|
+
ByType_5 as ByType
|
|
5736
5748
|
}
|
|
5737
5749
|
}
|
|
5738
5750
|
|
|
5739
5751
|
/**
|
|
5740
|
-
*
|
|
5752
|
+
* @deprecated Renamed to {@link EventType}.
|
|
5741
5753
|
*/
|
|
5742
|
-
declare type FrameEventType =
|
|
5754
|
+
declare type FrameEventType = EventType_5;
|
|
5743
5755
|
|
|
5744
5756
|
/**
|
|
5745
5757
|
* @interface
|
|
@@ -5958,14 +5970,9 @@ declare class GlobalHotkey extends EmitterBase<OpenFin_2.GlobalHotkeyEvent> {
|
|
|
5958
5970
|
}
|
|
5959
5971
|
|
|
5960
5972
|
/**
|
|
5961
|
-
*
|
|
5962
|
-
* discriminated by {@link GlobalHotkeyEvent.type | their type}. Event payloads unique to `GlobalHotkey` can be found
|
|
5963
|
-
* under the {@link OpenFin.GlobalHotkeyEvents} namespace.
|
|
5973
|
+
* @deprecated Renamed to {@link Event}.
|
|
5964
5974
|
*/
|
|
5965
|
-
declare type GlobalHotkeyEvent =
|
|
5966
|
-
topic: 'global-hotkey';
|
|
5967
|
-
hotkey: 'string';
|
|
5968
|
-
} & (RegisteredEvent | UnregisteredEvent);
|
|
5975
|
+
declare type GlobalHotkeyEvent = Event_9;
|
|
5969
5976
|
|
|
5970
5977
|
declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
|
|
5971
5978
|
|
|
@@ -5973,17 +5980,19 @@ declare namespace GlobalHotkeyEvents {
|
|
|
5973
5980
|
export {
|
|
5974
5981
|
RegisteredEvent,
|
|
5975
5982
|
UnregisteredEvent,
|
|
5983
|
+
Event_9 as Event,
|
|
5976
5984
|
GlobalHotkeyEvent,
|
|
5985
|
+
EventType_6 as EventType,
|
|
5977
5986
|
GlobalHotkeyEventType,
|
|
5978
|
-
|
|
5979
|
-
|
|
5987
|
+
Payload_7 as Payload,
|
|
5988
|
+
ByType_6 as ByType
|
|
5980
5989
|
}
|
|
5981
5990
|
}
|
|
5982
5991
|
|
|
5983
5992
|
/**
|
|
5984
|
-
*
|
|
5993
|
+
* @deprecated Renamed to {@link EventType}.
|
|
5985
5994
|
*/
|
|
5986
|
-
declare type GlobalHotkeyEventType =
|
|
5995
|
+
declare type GlobalHotkeyEventType = EventType_6;
|
|
5987
5996
|
|
|
5988
5997
|
declare namespace GoldenLayout {
|
|
5989
5998
|
export {
|
|
@@ -6285,16 +6294,25 @@ declare interface Header {
|
|
|
6285
6294
|
* Generated when a View is hidden.
|
|
6286
6295
|
* @interface
|
|
6287
6296
|
*/
|
|
6288
|
-
declare type HiddenEvent =
|
|
6297
|
+
declare type HiddenEvent = BaseEvent_4 & {
|
|
6289
6298
|
type: 'hidden';
|
|
6290
6299
|
};
|
|
6291
6300
|
|
|
6301
|
+
/**
|
|
6302
|
+
* Generated when a window has been hidden.
|
|
6303
|
+
* @interface
|
|
6304
|
+
*/
|
|
6305
|
+
declare type HiddenEvent_2 = BaseEvent_5 & {
|
|
6306
|
+
type: 'hidden';
|
|
6307
|
+
reason: 'closing' | 'hide' | 'hide-on-close';
|
|
6308
|
+
};
|
|
6309
|
+
|
|
6292
6310
|
/**
|
|
6293
6311
|
* Generated when the context of a View's host window changes, either due to a call to {@link Platform#setWindowContext Platform.setWindowContext},
|
|
6294
6312
|
* or because the View has moved to a new window. Only available on Views in a Platform.
|
|
6295
6313
|
* @interface
|
|
6296
6314
|
*/
|
|
6297
|
-
declare type HostContextChangedEvent =
|
|
6315
|
+
declare type HostContextChangedEvent = BaseEvent_4 & {
|
|
6298
6316
|
type: 'host-context-changed';
|
|
6299
6317
|
context: any;
|
|
6300
6318
|
reason: 'reparented' | 'updated';
|
|
@@ -6373,7 +6391,16 @@ declare type Hotkey = {
|
|
|
6373
6391
|
* @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
|
|
6374
6392
|
* @interface
|
|
6375
6393
|
*/
|
|
6376
|
-
declare type HotkeyEvent =
|
|
6394
|
+
declare type HotkeyEvent = BaseEvent_4 & {
|
|
6395
|
+
type: 'hotkey';
|
|
6396
|
+
};
|
|
6397
|
+
|
|
6398
|
+
/**
|
|
6399
|
+
* Generated when a keyboard shortcut defined in the `hotkeys` array in [Window options](OpenFin.WindowOptions.html) is pressed inside the window.
|
|
6400
|
+
* @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
|
|
6401
|
+
* @interface
|
|
6402
|
+
*/
|
|
6403
|
+
declare type HotkeyEvent_2 = InputEvent_2 & BaseEvent_5 & {
|
|
6377
6404
|
type: 'hotkey';
|
|
6378
6405
|
};
|
|
6379
6406
|
|
|
@@ -6426,6 +6453,11 @@ declare type IdentityEvent = BaseEvent & {
|
|
|
6426
6453
|
|
|
6427
6454
|
/* Excluded from this release type: IdEventType */
|
|
6428
6455
|
|
|
6456
|
+
/**
|
|
6457
|
+
* @deprecated Renamed to {@link IdleStateChangedEvent}.
|
|
6458
|
+
*/
|
|
6459
|
+
declare type IdleEvent = IdleStateChangedEvent;
|
|
6460
|
+
|
|
6429
6461
|
/**
|
|
6430
6462
|
* Generated when a user enters or returns from idle state.
|
|
6431
6463
|
* @remarks This method is continuously generated every minute while the user is in idle.
|
|
@@ -6433,7 +6465,7 @@ declare type IdentityEvent = BaseEvent & {
|
|
|
6433
6465
|
* A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
|
|
6434
6466
|
* @interface
|
|
6435
6467
|
*/
|
|
6436
|
-
declare type
|
|
6468
|
+
declare type IdleStateChangedEvent = BaseEvent_8 & {
|
|
6437
6469
|
type: 'idle-state-changed';
|
|
6438
6470
|
elapsedTime: number;
|
|
6439
6471
|
isIdle: boolean;
|
|
@@ -6518,11 +6550,19 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
|
|
|
6518
6550
|
* Generated when an application has initialized.
|
|
6519
6551
|
* @interface
|
|
6520
6552
|
*/
|
|
6521
|
-
declare type InitializedEvent = IdentityEvent & {
|
|
6553
|
+
declare type InitializedEvent = BaseEvents.IdentityEvent & {
|
|
6522
6554
|
topic: 'application';
|
|
6523
6555
|
type: 'initialized';
|
|
6524
6556
|
};
|
|
6525
6557
|
|
|
6558
|
+
/**
|
|
6559
|
+
* Generated when a window is initialized.
|
|
6560
|
+
* @interface
|
|
6561
|
+
*/
|
|
6562
|
+
declare type InitializedEvent_2 = BaseEvent_5 & {
|
|
6563
|
+
type: 'initialized';
|
|
6564
|
+
};
|
|
6565
|
+
|
|
6526
6566
|
/**
|
|
6527
6567
|
* @interface
|
|
6528
6568
|
*/
|
|
@@ -6563,6 +6603,13 @@ declare type InitPlatformOptions = {
|
|
|
6563
6603
|
interopOverride?: OverrideCallback<InteropBroker> | ConstructorOverride<InteropBroker>[];
|
|
6564
6604
|
};
|
|
6565
6605
|
|
|
6606
|
+
/**
|
|
6607
|
+
* * 'none': The `fin` API will be not available from within this context.
|
|
6608
|
+
* * 'global': The entire `fin` API will be available from within this context.
|
|
6609
|
+
* @defaultValue 'global'
|
|
6610
|
+
*/
|
|
6611
|
+
declare type InjectionType = 'none' | 'global';
|
|
6612
|
+
|
|
6566
6613
|
/**
|
|
6567
6614
|
* Generated when the value of the element changes.
|
|
6568
6615
|
* @interface
|
|
@@ -6907,56 +6954,6 @@ declare class InteropBroker extends Base {
|
|
|
6907
6954
|
static createClosedConstructor(...args: ConstructorParameters<typeof InteropBroker>): {
|
|
6908
6955
|
new (): InteropBroker;
|
|
6909
6956
|
};
|
|
6910
|
-
/**
|
|
6911
|
-
* @REMOVED
|
|
6912
|
-
* SetContextOptions interface
|
|
6913
|
-
* @typedef { object } SetContextOptions@typedef { object } SetContextOptions
|
|
6914
|
-
* @property { Context } {context} - New context to set.
|
|
6915
|
-
*/
|
|
6916
|
-
/**
|
|
6917
|
-
* @REMOVED
|
|
6918
|
-
* GetContextOptions interface
|
|
6919
|
-
* @typedef { object } GetContextOptions@typedef { object } GetContextOptions
|
|
6920
|
-
* @property { string } [contextType] - Context Type
|
|
6921
|
-
*/
|
|
6922
|
-
/**
|
|
6923
|
-
* @REMOVED
|
|
6924
|
-
* JoinContextGroupOptions interface
|
|
6925
|
-
* @typedef { object } JoinContextGroupOptions@typedef { object } JoinContextGroupOptions
|
|
6926
|
-
* @property { string } contextGroupId - Id of the context group.
|
|
6927
|
-
* @property { Identity | ClientIdentity } [target] - Identity of the entity you wish to join to a context group.
|
|
6928
|
-
*/
|
|
6929
|
-
/**
|
|
6930
|
-
* @REMOVED
|
|
6931
|
-
* AddClientToContextGroupOptions interface
|
|
6932
|
-
* @typedef { object } AddClientToContextGroupOptions@typedef { object } AddClientToContextGroupOptions
|
|
6933
|
-
* @property { string } contextGroupId - Name of the context group.
|
|
6934
|
-
*/
|
|
6935
|
-
/**
|
|
6936
|
-
* @REMOVED
|
|
6937
|
-
* RemoveFromContextGroupOptions interface
|
|
6938
|
-
* @typedef { object } RemoveFromContextGroupOptions@typedef { object } RemoveFromContextGroupOptions
|
|
6939
|
-
* @property { Identity | ClientIdentity } target - Identity of the entity you wish to join to a context group.
|
|
6940
|
-
*/
|
|
6941
|
-
/**
|
|
6942
|
-
* @REMOVED
|
|
6943
|
-
* GetInfoForContextGroupOptions interface
|
|
6944
|
-
* @typedef { object } GetInfoForContextGroupOptions@typedef { object } GetInfoForContextGroupOptions
|
|
6945
|
-
* @property { string } contextGroupId - Name of the context group to get info for.
|
|
6946
|
-
*/
|
|
6947
|
-
/**
|
|
6948
|
-
* @REMOVED
|
|
6949
|
-
* GetAllClientsInContextGroupOptions interface
|
|
6950
|
-
* @typedef { object } GetAllClientsInContextGroupOptions@typedef { object } GetAllClientsInContextGroupOptions
|
|
6951
|
-
* @property { string } contextGroupId - Name of the context group to get info for.
|
|
6952
|
-
*/
|
|
6953
|
-
/**
|
|
6954
|
-
* @PORTED
|
|
6955
|
-
* InfoForIntentOptions interface
|
|
6956
|
-
* @typedef { object } InfoForIntentOptions@typedef { object } InfoForIntentOptions
|
|
6957
|
-
* @property { string } name Name of the intent to get info for.
|
|
6958
|
-
* @property { Context } [context] Optional context.
|
|
6959
|
-
*/
|
|
6960
6957
|
/**
|
|
6961
6958
|
* Sets a context for the context group of the incoming current entity.
|
|
6962
6959
|
* @param setContextOptions - New context to set.
|
|
@@ -7200,7 +7197,7 @@ declare class InteropBroker extends Base {
|
|
|
7200
7197
|
* // }
|
|
7201
7198
|
* ```
|
|
7202
7199
|
*
|
|
7203
|
-
* More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/
|
|
7200
|
+
* More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/Metadata#intentresolution).
|
|
7204
7201
|
*
|
|
7205
7202
|
* @param contextForIntent Data passed between entities and applications.
|
|
7206
7203
|
* @param clientIdentity Identity of the Client making the request.
|
|
@@ -7457,97 +7454,6 @@ declare type InteropBrokerOptions = {
|
|
|
7457
7454
|
};
|
|
7458
7455
|
|
|
7459
7456
|
/**
|
|
7460
|
-
* @PORTED
|
|
7461
|
-
* @typedef { object } Intent
|
|
7462
|
-
* @summary The combination of an action and a context that is passed to an application for resolution.
|
|
7463
|
-
* @property { string } name Name of the intent.
|
|
7464
|
-
* @property { Context } context Data associated with the intent
|
|
7465
|
-
*/
|
|
7466
|
-
/**
|
|
7467
|
-
* @REMOVED
|
|
7468
|
-
* @typedef { object } Subscription
|
|
7469
|
-
* @summary Object returned when subscribing a handler.
|
|
7470
|
-
* @property { function } unsubscribe Function to unsubscribe the handler.
|
|
7471
|
-
*/
|
|
7472
|
-
/**
|
|
7473
|
-
* @typedef { function } ContextHandler
|
|
7474
|
-
* @summary Subscription function for addContextHandler.
|
|
7475
|
-
*/
|
|
7476
|
-
/**
|
|
7477
|
-
* @typedef { function } IntentHandler
|
|
7478
|
-
* @summary Subscription function for registerIntentHandler
|
|
7479
|
-
*/
|
|
7480
|
-
/**
|
|
7481
|
-
* @PORTED
|
|
7482
|
-
* @typedef { object } ClientIdentity
|
|
7483
|
-
* @summary The Identity for a Channel Client. Includes endpointId to differentiate between different connections for an entity.
|
|
7484
|
-
* @property {string} uuid GUID of an application.
|
|
7485
|
-
* @property {string} name Name of an entity in an application.
|
|
7486
|
-
* @property {string} endpointId Unique differentiator for different Channel connections for an entity.
|
|
7487
|
-
*/
|
|
7488
|
-
/**
|
|
7489
|
-
* @PORTED
|
|
7490
|
-
* @typedef { object } ContextGroupInfo
|
|
7491
|
-
* @summary Information for a Context Group. Contains metadata for displaying the group properly.
|
|
7492
|
-
* @property {string} id Name of the context group
|
|
7493
|
-
* @property {DisplayMetadata} displayMetadata Metadata for the Context Group. Contains the group's human-readable name, color, and an image, as defined by the Interop Broker.
|
|
7494
|
-
*/
|
|
7495
|
-
/**
|
|
7496
|
-
* @PORTED
|
|
7497
|
-
* @typedef { object } DisplayMetadata
|
|
7498
|
-
* @summary The display data for a Context Group.
|
|
7499
|
-
* @property {string} name A user-readable name for this context group, e.g: `"Red"`
|
|
7500
|
-
* @property {string} [color] The color that should be associated within this context group when displaying this context group in a UI, e.g: `0xFF0000`.
|
|
7501
|
-
* @property {string} [glyph] A URL of an image that can be used to display this context group
|
|
7502
|
-
*/
|
|
7503
|
-
/**
|
|
7504
|
-
* @PORTED
|
|
7505
|
-
* @typedef { object } Context
|
|
7506
|
-
* @summary Data passed between entities and applications.
|
|
7507
|
-
* @property {object} [id] An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
|
|
7508
|
-
* @property {string} [name] User-readable name for the incoming context.
|
|
7509
|
-
* @property {string} type Conserved type for the context (e.g. `instrument` or `country`)
|
|
7510
|
-
*/
|
|
7511
|
-
/**
|
|
7512
|
-
* @REMOVED
|
|
7513
|
-
* @typedef { object } ContextForIntent
|
|
7514
|
-
* @summary Data passed between entities and applications, including an optional metadata.
|
|
7515
|
-
* @property {object} [id] An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
|
|
7516
|
-
* @property {string} [name] User-readable name for the incoming context.
|
|
7517
|
-
* @property {string} type Conserved type for the context (e.g. `instrument` or `country`)
|
|
7518
|
-
* @property {any} [metadata]
|
|
7519
|
-
*/
|
|
7520
|
-
/**
|
|
7521
|
-
* @REMOVED
|
|
7522
|
-
* @typedef { object } SessionContextGroup
|
|
7523
|
-
* @summary An instance of a SessionContextGroup
|
|
7524
|
-
* @property {string} id The SessionContextGroup's id.
|
|
7525
|
-
* @property {setContext} setContext Sets a context of a certain type
|
|
7526
|
-
* @property {getCurrentContext} getCurrentContext Gets the currently set context of a certain type
|
|
7527
|
-
* @property {addContextHandler} addContextHandler Adds a handler for context change.
|
|
7528
|
-
*/
|
|
7529
|
-
/**
|
|
7530
|
-
* @typedef {function} setContext
|
|
7531
|
-
* @summary A SessionContextGroup instance method for setting a context in the SessionContextGroup.
|
|
7532
|
-
* @param context The Context to be set.
|
|
7533
|
-
*
|
|
7534
|
-
*/
|
|
7535
|
-
/**
|
|
7536
|
-
* @typedef {function} getCurrentContext
|
|
7537
|
-
* @summary A SessionContextGroup instance method for getting the current context of a certain type.
|
|
7538
|
-
* @param contextType The Context Type to get. If not specified the last contextType set would get used.
|
|
7539
|
-
*
|
|
7540
|
-
*/
|
|
7541
|
-
/**
|
|
7542
|
-
* @typedef {function} addContextHandler
|
|
7543
|
-
* @summary A SessionContextGroup instance method for adding a handler for context change.
|
|
7544
|
-
* @param contextHandler The callback to be invoked. Is invoked when (a) the context changes or (b) immediately after getting created if the context is already set.
|
|
7545
|
-
* @param contextType The context type this handler should listen to. If not specified, a global handler for all context types will get created. Only one global handler is allowed per SessionContextGroup.
|
|
7546
|
-
*
|
|
7547
|
-
*/
|
|
7548
|
-
/**
|
|
7549
|
-
* {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}
|
|
7550
|
-
*
|
|
7551
7457
|
* The Interop Client API is broken up into two groups:
|
|
7552
7458
|
*
|
|
7553
7459
|
* **Content Facing APIs** - For Application Developers putting Views into a Platform Window, who care about Context. These are APIs that send out and receive the Context data that flows between applications. Think of this as the Water in the Interop Pipes.
|
|
@@ -7950,7 +7856,7 @@ declare class InteropClient extends Base {
|
|
|
7950
7856
|
* ```
|
|
7951
7857
|
*/
|
|
7952
7858
|
onDisconnection(listener: OpenFin_2.InteropClientOnDisconnectionListener): Promise<void>;
|
|
7953
|
-
|
|
7859
|
+
/* Excluded from this release type: ferryFdc3Call */
|
|
7954
7860
|
}
|
|
7955
7861
|
|
|
7956
7862
|
/**
|
|
@@ -7980,13 +7886,6 @@ declare type InteropLoggingActions = 'beforeAction' | 'afterAction';
|
|
|
7980
7886
|
*/
|
|
7981
7887
|
declare type InteropLoggingOptions = Record<InteropLoggingActions, InteropActionLoggingOption>;
|
|
7982
7888
|
|
|
7983
|
-
/**
|
|
7984
|
-
* @PORTED
|
|
7985
|
-
* @typedef { object } InteropConfig
|
|
7986
|
-
* @summary Information relevant to the Interop Broker.
|
|
7987
|
-
* @property {string} [currentContextGroup] Context Group for the client. (green, yellow, red, etc.)
|
|
7988
|
-
* @property {string} [providerId] When provided, automatically connects the client to the specified provider uuid
|
|
7989
|
-
*/
|
|
7990
7889
|
/**
|
|
7991
7890
|
* Manages creation of Interop Brokers and Interop Clients. These APIs are called under-the-hood in Platforms.
|
|
7992
7891
|
*
|
|
@@ -8374,7 +8273,7 @@ declare type LaunchIntoPlatformPayload = {
|
|
|
8374
8273
|
declare class Layout extends Base {
|
|
8375
8274
|
#private;
|
|
8376
8275
|
/* Excluded from this release type: init */
|
|
8377
|
-
identity: OpenFin_2.LayoutIdentity;
|
|
8276
|
+
identity: OpenFin_2.Identity | OpenFin_2.LayoutIdentity;
|
|
8378
8277
|
private platform;
|
|
8379
8278
|
wire: Transport;
|
|
8380
8279
|
/* Excluded from this release type: __constructor */
|
|
@@ -8590,25 +8489,24 @@ declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'r
|
|
|
8590
8489
|
*/
|
|
8591
8490
|
declare type LayoutIdentity = Identity_5 & {
|
|
8592
8491
|
/**
|
|
8593
|
-
* The name of the layout
|
|
8594
|
-
* OpenFin attempts to resolve the instance via visibility checks.
|
|
8492
|
+
* The name of the layout in a given window.
|
|
8595
8493
|
*/
|
|
8596
|
-
layoutName
|
|
8494
|
+
layoutName: string;
|
|
8597
8495
|
};
|
|
8598
8496
|
|
|
8599
8497
|
/**
|
|
8600
|
-
* Generated when
|
|
8498
|
+
* Generated when the window is created, and all of its layout's views have either finished or failed
|
|
8499
|
+
* navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
|
|
8601
8500
|
* @interface
|
|
8602
8501
|
*/
|
|
8603
|
-
declare type LayoutInitializedEvent =
|
|
8502
|
+
declare type LayoutInitializedEvent = BaseEvent_5 & {
|
|
8604
8503
|
type: 'layout-initialized';
|
|
8504
|
+
layoutIdentity: OpenFin_2.LayoutIdentity;
|
|
8605
8505
|
ofViews: (OpenFin_2.Identity & {
|
|
8606
8506
|
entityType: 'view';
|
|
8607
8507
|
})[];
|
|
8608
8508
|
};
|
|
8609
8509
|
|
|
8610
|
-
/* Excluded from this release type: LayoutInstance */
|
|
8611
|
-
|
|
8612
8510
|
/**
|
|
8613
8511
|
* Represents the arrangement of Views within a Platform window's Layout. We do not recommend trying
|
|
8614
8512
|
* to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot}.
|
|
@@ -8636,7 +8534,7 @@ declare type LayoutItemConfig = {
|
|
|
8636
8534
|
*
|
|
8637
8535
|
* **NOTE**: Internal use only. This type is reserved for Workspace Browser implementation.
|
|
8638
8536
|
*
|
|
8639
|
-
* Responsible for
|
|
8537
|
+
* Responsible for aggregating all layout snapshots and storing layout instances
|
|
8640
8538
|
*/
|
|
8641
8539
|
declare interface LayoutManager<T extends LayoutSnapshot> {
|
|
8642
8540
|
/**
|
|
@@ -8660,16 +8558,6 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
|
|
|
8660
8558
|
* @throws if Object.keys(snapshot).length > 1
|
|
8661
8559
|
*/
|
|
8662
8560
|
applyLayoutSnapshot(snapshot: T): Promise<void>;
|
|
8663
|
-
/**
|
|
8664
|
-
* Called at the start of layout initialization. Adds a new LayoutInstance if the snapshot
|
|
8665
|
-
* contains a single layout.
|
|
8666
|
-
*
|
|
8667
|
-
* Throws if the snapshot contains more than 1 layout, it is expected that the user handles calling
|
|
8668
|
-
* fin.Platform.Layout.create() once for each layout to properly connect it to their UI state.
|
|
8669
|
-
*
|
|
8670
|
-
* @param snapshot
|
|
8671
|
-
* @throws if Object.keys(snapshot).length > 1
|
|
8672
|
-
*/
|
|
8673
8561
|
/**
|
|
8674
8562
|
* @experimental
|
|
8675
8563
|
*
|
|
@@ -8690,31 +8578,49 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
|
|
|
8690
8578
|
/**
|
|
8691
8579
|
* @experimental
|
|
8692
8580
|
*
|
|
8693
|
-
*
|
|
8694
|
-
*
|
|
8581
|
+
* A hook provided to the consumer for controlling how OpenFin routes Layout API calls. Override
|
|
8582
|
+
* this method to control the target layout for Layout API calls.
|
|
8583
|
+
*
|
|
8584
|
+
* Example use case: You have hidden all the layouts and are showing a dialog that will
|
|
8585
|
+
* execute an API call (ex: Layout.replace()) - override this method and save the
|
|
8586
|
+
* "last visible" layout identity and return it.
|
|
8587
|
+
*
|
|
8588
|
+
* By default, OpenFin will use a series of checks to determine which Layout the API
|
|
8589
|
+
* call must route to in this order of precedence:
|
|
8590
|
+
* - try to resolve the layout from the layoutIdentity, throws if missing
|
|
8591
|
+
* - if there is only 1 layout, resolves that one
|
|
8592
|
+
* - enumerates all layouts checks visibility via element offsetTop/Left + window.innerHeight/Width
|
|
8593
|
+
* - returns undefined
|
|
8594
|
+
*
|
|
8595
|
+
* @param identity
|
|
8596
|
+
* @returns LayoutIdentity | undefined
|
|
8695
8597
|
*/
|
|
8696
|
-
|
|
8598
|
+
resolveLayoutIdentity(identity?: Identity_5 | LayoutIdentity): LayoutIdentity | undefined;
|
|
8697
8599
|
/**
|
|
8698
8600
|
* @experimental
|
|
8699
8601
|
*
|
|
8700
|
-
*
|
|
8701
|
-
*
|
|
8702
|
-
*
|
|
8703
|
-
*
|
|
8602
|
+
* A hook provided to the consumer when it's time to remove a layout. Use this hook to
|
|
8603
|
+
* update your local state and remove the layout for the given LayoutIdentity. Note that
|
|
8604
|
+
* this hook does not call `fin.Platform.Layout.destroy()` for you, instead it is to
|
|
8605
|
+
* signify to your application it's time to destroy this layout.
|
|
8606
|
+
*
|
|
8607
|
+
* 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.
|
|
8608
|
+
*
|
|
8609
|
+
* @param LayoutIdentity
|
|
8704
8610
|
*/
|
|
8705
|
-
|
|
8611
|
+
removeLayout({ layoutName }: LayoutIdentity): Promise<void>;
|
|
8706
8612
|
/**
|
|
8707
8613
|
* @experimental
|
|
8708
8614
|
*/
|
|
8709
|
-
|
|
8615
|
+
getLayoutIdentityForView(viewIdentity: Identity_5): LayoutIdentity;
|
|
8710
8616
|
/**
|
|
8711
8617
|
* @experimental
|
|
8712
8618
|
*/
|
|
8713
|
-
|
|
8619
|
+
isLayoutVisible({ layoutName }: LayoutIdentity): boolean;
|
|
8714
8620
|
/**
|
|
8715
8621
|
* @experimental
|
|
8716
8622
|
*/
|
|
8717
|
-
|
|
8623
|
+
size(): number;
|
|
8718
8624
|
}
|
|
8719
8625
|
|
|
8720
8626
|
/**
|
|
@@ -8761,7 +8667,7 @@ declare class LayoutModule extends Base {
|
|
|
8761
8667
|
* const layoutConfig = await layout.getConfig();
|
|
8762
8668
|
* ```
|
|
8763
8669
|
*/
|
|
8764
|
-
wrap(identity: OpenFin_2.LayoutIdentity): Promise<OpenFin_2.Layout>;
|
|
8670
|
+
wrap(identity: OpenFin_2.Identity | OpenFin_2.LayoutIdentity): Promise<OpenFin_2.Layout>;
|
|
8765
8671
|
/**
|
|
8766
8672
|
* Synchronously returns a Layout object that represents a Window's layout.
|
|
8767
8673
|
*
|
|
@@ -8781,7 +8687,7 @@ declare class LayoutModule extends Base {
|
|
|
8781
8687
|
* const layoutConfig = await layout.getConfig();
|
|
8782
8688
|
* ```
|
|
8783
8689
|
*/
|
|
8784
|
-
wrapSync(identity: OpenFin_2.LayoutIdentity): OpenFin_2.Layout;
|
|
8690
|
+
wrapSync(identity: OpenFin_2.Identity | OpenFin_2.LayoutIdentity): OpenFin_2.Layout;
|
|
8785
8691
|
/**
|
|
8786
8692
|
* Asynchronously returns a Layout object that represents a Window's layout.
|
|
8787
8693
|
*
|
|
@@ -8878,7 +8784,7 @@ declare type LayoutOptions = {
|
|
|
8878
8784
|
* @defaultValue false
|
|
8879
8785
|
*
|
|
8880
8786
|
* Limits the area to which tabs can be dragged.
|
|
8881
|
-
* If true,
|
|
8787
|
+
* If true, the layout container is the only area where tabs can be dropped.
|
|
8882
8788
|
*/
|
|
8883
8789
|
constrainDragToContainer?: boolean;
|
|
8884
8790
|
/**
|
|
@@ -8949,19 +8855,23 @@ declare type LayoutOptions = {
|
|
|
8949
8855
|
};
|
|
8950
8856
|
};
|
|
8951
8857
|
|
|
8858
|
+
/**
|
|
8859
|
+
* Represents the position of an item in a layout relative to another.
|
|
8860
|
+
*/
|
|
8952
8861
|
declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
|
|
8953
8862
|
|
|
8954
8863
|
/**
|
|
8955
|
-
*
|
|
8864
|
+
* Layout preset type.
|
|
8956
8865
|
*/
|
|
8957
8866
|
declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
|
|
8958
8867
|
|
|
8959
8868
|
/**
|
|
8960
|
-
* Generated when
|
|
8869
|
+
* Generated when the layout and all of the its views have been created and can receive API calls.
|
|
8961
8870
|
* @interface
|
|
8962
8871
|
*/
|
|
8963
|
-
declare type LayoutReadyEvent =
|
|
8872
|
+
declare type LayoutReadyEvent = BaseEvent_5 & {
|
|
8964
8873
|
type: 'layout-ready';
|
|
8874
|
+
layoutIdentity: OpenFin_2.LayoutIdentity;
|
|
8965
8875
|
views: (OpenFin_2.Identity & {
|
|
8966
8876
|
success: boolean;
|
|
8967
8877
|
})[];
|
|
@@ -9101,7 +9011,7 @@ declare type Manifest = {
|
|
|
9101
9011
|
* Generated when the RVM notifies an application that the manifest has changed.
|
|
9102
9012
|
* @interface
|
|
9103
9013
|
*/
|
|
9104
|
-
declare type ManifestChangedEvent = IdentityEvent & {
|
|
9014
|
+
declare type ManifestChangedEvent = BaseEvents.IdentityEvent & {
|
|
9105
9015
|
topic: 'application';
|
|
9106
9016
|
type: 'manifest-changed';
|
|
9107
9017
|
};
|
|
@@ -9154,7 +9064,7 @@ declare type MatchPattern = string;
|
|
|
9154
9064
|
* Generated when a window is maximized.
|
|
9155
9065
|
* @interface
|
|
9156
9066
|
*/
|
|
9157
|
-
declare type MaximizedEvent =
|
|
9067
|
+
declare type MaximizedEvent = BaseEvent_5 & {
|
|
9158
9068
|
type: 'maximized';
|
|
9159
9069
|
};
|
|
9160
9070
|
|
|
@@ -9264,7 +9174,7 @@ declare type MessagingProtocols = ProtocolOffer['type'];
|
|
|
9264
9174
|
* Generated when a window is minimized.
|
|
9265
9175
|
* @interface
|
|
9266
9176
|
*/
|
|
9267
|
-
declare type MinimizedEvent =
|
|
9177
|
+
declare type MinimizedEvent = BaseEvent_5 & {
|
|
9268
9178
|
type: 'minimized';
|
|
9269
9179
|
};
|
|
9270
9180
|
|
|
@@ -9308,14 +9218,9 @@ declare type MonitorDetails = {
|
|
|
9308
9218
|
};
|
|
9309
9219
|
|
|
9310
9220
|
/**
|
|
9311
|
-
*
|
|
9312
|
-
* @remarks A monitor's size changes when the taskbar is resized or relocated.
|
|
9313
|
-
* The available space of a monitor defines a rectangle that is not occupied by the taskbar
|
|
9314
|
-
* @interface
|
|
9221
|
+
* @deprecated Renamed to {@link MonitorInfoChangedEvent}.
|
|
9315
9222
|
*/
|
|
9316
|
-
declare type MonitorEvent =
|
|
9317
|
-
type: 'monitor-info-changed';
|
|
9318
|
-
};
|
|
9223
|
+
declare type MonitorEvent = MonitorInfoChangedEvent;
|
|
9319
9224
|
|
|
9320
9225
|
/**
|
|
9321
9226
|
* @interface
|
|
@@ -9339,6 +9244,16 @@ declare type MonitorInfo = {
|
|
|
9339
9244
|
virtualScreen: DipRect;
|
|
9340
9245
|
};
|
|
9341
9246
|
|
|
9247
|
+
/**
|
|
9248
|
+
* Generated on changes of a monitor's size/location.
|
|
9249
|
+
* @remarks A monitor's size changes when the taskbar is resized or relocated.
|
|
9250
|
+
* The available space of a monitor defines a rectangle that is not occupied by the taskbar
|
|
9251
|
+
* @interface
|
|
9252
|
+
*/
|
|
9253
|
+
declare type MonitorInfoChangedEvent = BaseEvent_8 & OpenFin_2.MonitorInfo & {
|
|
9254
|
+
type: 'monitor-info-changed';
|
|
9255
|
+
};
|
|
9256
|
+
|
|
9342
9257
|
/**
|
|
9343
9258
|
* @interface
|
|
9344
9259
|
*/
|
|
@@ -9661,7 +9576,7 @@ declare type MutableWindowOptions = {
|
|
|
9661
9576
|
showTaskbarIcon: boolean;
|
|
9662
9577
|
interop: InteropConfig;
|
|
9663
9578
|
/* Excluded from this release type: _internalWorkspaceData */
|
|
9664
|
-
|
|
9579
|
+
/* Excluded from this release type: workspacePlatform */
|
|
9665
9580
|
};
|
|
9666
9581
|
|
|
9667
9582
|
declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;
|
|
@@ -9735,13 +9650,15 @@ declare type NonPropagatedWebContentsEvent = never;
|
|
|
9735
9650
|
*/
|
|
9736
9651
|
declare type NonPropagatedWindowEvent = never;
|
|
9737
9652
|
|
|
9653
|
+
/* Excluded from this release type: NotCloseRequested */
|
|
9654
|
+
|
|
9738
9655
|
/* Excluded from this release type: NotRequested */
|
|
9739
9656
|
|
|
9740
9657
|
/**
|
|
9741
9658
|
* Generated when an application is not responding.
|
|
9742
9659
|
* @interface
|
|
9743
9660
|
*/
|
|
9744
|
-
declare type NotRespondingEvent = IdentityEvent & {
|
|
9661
|
+
declare type NotRespondingEvent = BaseEvents.IdentityEvent & {
|
|
9745
9662
|
topic: 'application';
|
|
9746
9663
|
type: 'not-responding';
|
|
9747
9664
|
};
|
|
@@ -9847,6 +9764,7 @@ declare namespace OpenFin_2 {
|
|
|
9847
9764
|
ResizeRegion,
|
|
9848
9765
|
Accelerator,
|
|
9849
9766
|
Api,
|
|
9767
|
+
InjectionType,
|
|
9850
9768
|
NavigationRules,
|
|
9851
9769
|
ContentNavigation,
|
|
9852
9770
|
ContentRedirect,
|
|
@@ -9892,6 +9810,7 @@ declare namespace OpenFin_2 {
|
|
|
9892
9810
|
WebPermission,
|
|
9893
9811
|
VerboseWebPermission,
|
|
9894
9812
|
OpenExternalPermission,
|
|
9813
|
+
DeviceInfo,
|
|
9895
9814
|
Permissions_2 as Permissions,
|
|
9896
9815
|
PlatformWindowCreationOptions,
|
|
9897
9816
|
PlatformWindowOptions,
|
|
@@ -9993,6 +9912,9 @@ declare namespace OpenFin_2 {
|
|
|
9993
9912
|
RuntimeInfo,
|
|
9994
9913
|
DefaultDomainSettings,
|
|
9995
9914
|
DefaultDomainSettingsRule,
|
|
9915
|
+
DomainSettings,
|
|
9916
|
+
ApiInjection,
|
|
9917
|
+
DomainSettingsRule,
|
|
9996
9918
|
FileDownloadBehaviorNames,
|
|
9997
9919
|
FileDownloadSettings,
|
|
9998
9920
|
DownloadRule,
|
|
@@ -10049,7 +9971,6 @@ declare namespace OpenFin_2 {
|
|
|
10049
9971
|
InitLayoutOptions,
|
|
10050
9972
|
LayoutManagerConstructor,
|
|
10051
9973
|
LayoutManagerOverride,
|
|
10052
|
-
LayoutInstance,
|
|
10053
9974
|
LayoutManager,
|
|
10054
9975
|
CreateLayoutOptions,
|
|
10055
9976
|
PresetLayoutOptions_2 as PresetLayoutOptions,
|
|
@@ -10067,7 +9988,7 @@ declare namespace OpenFin_2 {
|
|
|
10067
9988
|
AppVersionCompleteEvent,
|
|
10068
9989
|
AppVersionRuntimeStatusEvent,
|
|
10069
9990
|
Events,
|
|
10070
|
-
|
|
9991
|
+
BaseEvent_9 as BaseEvent,
|
|
10071
9992
|
WebContentsEvent_2 as WebContentsEvent,
|
|
10072
9993
|
SystemEvent_2 as SystemEvent,
|
|
10073
9994
|
ApplicationEvent_2 as ApplicationEvent,
|
|
@@ -10109,12 +10030,32 @@ export default OpenFin_2;
|
|
|
10109
10030
|
|
|
10110
10031
|
declare type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
|
|
10111
10032
|
|
|
10033
|
+
/**
|
|
10034
|
+
* Generated after window options are changed using the window.updateOptions method.
|
|
10035
|
+
* @remarks Will not fire if the diff object is empty.
|
|
10036
|
+
* @interface
|
|
10037
|
+
*/
|
|
10038
|
+
declare type OptionsChangedEvent = BaseEvent_5 & {
|
|
10039
|
+
type: 'options-changed';
|
|
10040
|
+
options: OpenFin_2.WindowOptions;
|
|
10041
|
+
diff: OpenFin_2.WindowOptionDiff;
|
|
10042
|
+
};
|
|
10043
|
+
|
|
10112
10044
|
declare type OverlapsOnlyIfMatching<T, U> = {
|
|
10113
10045
|
[K in Extract<keyof T, keyof U>]: U[K] extends T[K] ? U[K] : T[K] extends U[K] ? T[K] : never;
|
|
10114
10046
|
};
|
|
10115
10047
|
|
|
10116
10048
|
declare type OverrideCallback<T extends any = PlatformProvider, U extends T = T> = (arg: Constructor<T>) => U | Promise<U>;
|
|
10117
10049
|
|
|
10050
|
+
/**
|
|
10051
|
+
* Generated when page receives favicon urls.
|
|
10052
|
+
* @interface
|
|
10053
|
+
*/
|
|
10054
|
+
declare type PageFaviconUpdatedEvent = NamedEvent & {
|
|
10055
|
+
type: 'page-favicon-updated';
|
|
10056
|
+
favicons: string[];
|
|
10057
|
+
};
|
|
10058
|
+
|
|
10118
10059
|
/**
|
|
10119
10060
|
* Generated when page title is set during navigation.
|
|
10120
10061
|
* @remarks explicitSet is false when title is synthesized from file url.
|
|
@@ -10133,74 +10074,74 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
|
|
|
10133
10074
|
};
|
|
10134
10075
|
|
|
10135
10076
|
/**
|
|
10136
|
-
* Extracts a single event type matching the given key from the {@link
|
|
10077
|
+
* Extracts a single event type matching the given key from the View {@link Event} union.
|
|
10137
10078
|
*
|
|
10138
10079
|
* @typeParam Type String key specifying the event to extract
|
|
10139
10080
|
*/
|
|
10140
|
-
declare type Payload_2<Type extends
|
|
10081
|
+
declare type Payload_2<Type extends EventType> = Extract<Event_4, {
|
|
10141
10082
|
type: Type;
|
|
10142
10083
|
}>;
|
|
10143
10084
|
|
|
10144
10085
|
/**
|
|
10145
|
-
* Extracts a single event type matching the given key from the {@link
|
|
10086
|
+
* Extracts a single event type matching the given key from the Window {@link Event} union.
|
|
10146
10087
|
*
|
|
10147
10088
|
* @typeParam Type String key specifying the event to extract
|
|
10148
10089
|
*/
|
|
10149
|
-
declare type Payload_3<Type extends
|
|
10090
|
+
declare type Payload_3<Type extends EventType_2> = Extract<Event_6, {
|
|
10150
10091
|
type: Type;
|
|
10151
10092
|
}>;
|
|
10152
10093
|
|
|
10153
10094
|
/**
|
|
10154
|
-
* Extracts a single event type matching the given key from the {@link
|
|
10095
|
+
* Extracts a single event type matching the given key from the Application {@link Event} union.
|
|
10155
10096
|
*
|
|
10156
10097
|
* @typeParam Type String key specifying the event to extract
|
|
10157
10098
|
*/
|
|
10158
|
-
declare type Payload_4<Type extends
|
|
10099
|
+
declare type Payload_4<Type extends EventType_3> = Extract<Event_3, {
|
|
10159
10100
|
type: Type;
|
|
10160
10101
|
}>;
|
|
10161
10102
|
|
|
10162
10103
|
/**
|
|
10163
|
-
* Extracts a single event type matching the given key from the {@link
|
|
10104
|
+
* Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
|
|
10164
10105
|
*
|
|
10165
10106
|
* @typeParam Type String key specifying the event to extract
|
|
10166
10107
|
*/
|
|
10167
|
-
declare type Payload_5<Type extends
|
|
10108
|
+
declare type Payload_5<Type extends EventType_4> = Extract<Event_7, {
|
|
10168
10109
|
type: Type;
|
|
10169
10110
|
}>;
|
|
10170
10111
|
|
|
10171
10112
|
/**
|
|
10172
|
-
* Extracts a single event type matching the given key from the {@link
|
|
10113
|
+
* Extracts a single event type matching the given key from the Frame {@link Event} union.
|
|
10173
10114
|
*
|
|
10174
10115
|
* @typeParam Type String key specifying the event to extract
|
|
10175
10116
|
*/
|
|
10176
|
-
declare type Payload_6<Type extends
|
|
10117
|
+
declare type Payload_6<Type extends EventType_5> = Extract<Event_8, {
|
|
10177
10118
|
type: Type;
|
|
10178
10119
|
}>;
|
|
10179
10120
|
|
|
10180
10121
|
/**
|
|
10181
|
-
* Extracts a single event type matching the given key from the {@link
|
|
10122
|
+
* Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
|
|
10182
10123
|
*
|
|
10183
10124
|
* @typeParam Type String key specifying the event to extract
|
|
10184
10125
|
*/
|
|
10185
|
-
declare type Payload_7<Type extends
|
|
10126
|
+
declare type Payload_7<Type extends EventType_6> = Extract<Event_9, {
|
|
10186
10127
|
type: Type;
|
|
10187
10128
|
}>;
|
|
10188
10129
|
|
|
10189
10130
|
/**
|
|
10190
|
-
* Extracts a single event type matching the given key from the {@link
|
|
10131
|
+
* Extracts a single event type matching the given key from the Platform {@link Event} union.
|
|
10191
10132
|
*
|
|
10192
10133
|
* @typeParam Type String key specifying the event to extract
|
|
10193
10134
|
*/
|
|
10194
|
-
declare type Payload_8<Type extends
|
|
10135
|
+
declare type Payload_8<Type extends EventType_7> = Extract<Event_10, {
|
|
10195
10136
|
type: Type;
|
|
10196
10137
|
}>;
|
|
10197
10138
|
|
|
10198
10139
|
/**
|
|
10199
|
-
* Extracts a single event type matching the given key from the {@link
|
|
10140
|
+
* Extracts a single event type matching the given key from the System {@link Event} union.
|
|
10200
10141
|
*
|
|
10201
10142
|
* @typeParam Type String key specifying the event to extract
|
|
10202
10143
|
*/
|
|
10203
|
-
declare type Payload_9<Type extends
|
|
10144
|
+
declare type Payload_9<Type extends EventType_8> = Extract<Event_11, {
|
|
10204
10145
|
type: Type;
|
|
10205
10146
|
}>;
|
|
10206
10147
|
|
|
@@ -10210,7 +10151,7 @@ declare type PayloadTypeByStrategy<T extends ChannelStrategy<unknown>> = T exten
|
|
|
10210
10151
|
* Generated when window finishes loading. Provides performance and navigation data.
|
|
10211
10152
|
* @interface
|
|
10212
10153
|
*/
|
|
10213
|
-
declare type PerformanceReportEvent = Performance &
|
|
10154
|
+
declare type PerformanceReportEvent = Performance & BaseEvent_5 & {
|
|
10214
10155
|
type: 'performance-report';
|
|
10215
10156
|
};
|
|
10216
10157
|
|
|
@@ -10221,6 +10162,7 @@ declare type Permissions_2 = {
|
|
|
10221
10162
|
Application?: Partial<ApplicationPermissions>;
|
|
10222
10163
|
System?: Partial<SystemPermissions>;
|
|
10223
10164
|
webAPIs?: WebPermission[];
|
|
10165
|
+
devices?: DeviceInfo[];
|
|
10224
10166
|
};
|
|
10225
10167
|
|
|
10226
10168
|
declare type PermissionState_2 = 'granted' | 'denied' | 'unavailable';
|
|
@@ -10844,38 +10786,36 @@ declare class Platform extends EmitterBase<OpenFin_2.PlatformEvent> {
|
|
|
10844
10786
|
}
|
|
10845
10787
|
|
|
10846
10788
|
/**
|
|
10847
|
-
*
|
|
10848
|
-
* @interface
|
|
10789
|
+
* @deprecated Renamed to {@link ApiReadyEvent}.
|
|
10849
10790
|
*/
|
|
10850
|
-
declare type PlatformApiReadyEvent =
|
|
10851
|
-
topic: 'application';
|
|
10852
|
-
type: 'platform-api-ready';
|
|
10853
|
-
};
|
|
10791
|
+
declare type PlatformApiReadyEvent = ApiReadyEvent;
|
|
10854
10792
|
|
|
10855
10793
|
/**
|
|
10856
|
-
*
|
|
10857
|
-
* discriminated by {@link PlatformEvent.type | their type}. Event payloads unique to `Platform` can be found
|
|
10858
|
-
* under the {@link OpenFin.PlatformEvents} namespace.
|
|
10794
|
+
* @deprecated Renamed to {@link Event}.
|
|
10859
10795
|
*/
|
|
10860
|
-
declare type PlatformEvent =
|
|
10796
|
+
declare type PlatformEvent = Event_10;
|
|
10861
10797
|
|
|
10862
10798
|
declare type PlatformEvent_2 = Events.PlatformEvents.PlatformEvent;
|
|
10863
10799
|
|
|
10864
10800
|
declare namespace PlatformEvents {
|
|
10865
10801
|
export {
|
|
10802
|
+
ApiReadyEvent,
|
|
10866
10803
|
PlatformApiReadyEvent,
|
|
10804
|
+
SnapshotAppliedEvent,
|
|
10867
10805
|
PlatformSnapshotAppliedEvent,
|
|
10806
|
+
Event_10 as Event,
|
|
10868
10807
|
PlatformEvent,
|
|
10808
|
+
EventType_7 as EventType,
|
|
10869
10809
|
PlatformEventType,
|
|
10870
|
-
|
|
10871
|
-
|
|
10810
|
+
Payload_8 as Payload,
|
|
10811
|
+
ByType_7 as ByType
|
|
10872
10812
|
}
|
|
10873
10813
|
}
|
|
10874
10814
|
|
|
10875
10815
|
/**
|
|
10876
|
-
*
|
|
10816
|
+
* @deprecated Renamed to {@link }.
|
|
10877
10817
|
*/
|
|
10878
|
-
declare type PlatformEventType =
|
|
10818
|
+
declare type PlatformEventType = EventType_7;
|
|
10879
10819
|
|
|
10880
10820
|
/**
|
|
10881
10821
|
* Static namespace for OpenFin API methods that interact with the {@link Platform} class, available under `fin.Platform`.
|
|
@@ -11135,7 +11075,17 @@ declare interface PlatformProvider {
|
|
|
11135
11075
|
*/
|
|
11136
11076
|
getSnapshot(payload: undefined, identity: OpenFin_2.Identity): Promise<OpenFin_2.Snapshot>;
|
|
11137
11077
|
/* Excluded from this release type: getInitialLayoutSnapshot */
|
|
11138
|
-
|
|
11078
|
+
/**
|
|
11079
|
+
* @experimental
|
|
11080
|
+
*
|
|
11081
|
+
* This API is called during the {@link PlatformProvider.getSnapshot()} call.
|
|
11082
|
+
* Gets the current state of a particular window and its views and returns an object that
|
|
11083
|
+
* can be added to the {@link OpenFin.Snapshot.windows} property. Override this function if
|
|
11084
|
+
* you wish to mutate each window snapshot during the {@link PlatformProvider.getSnapshot()} call
|
|
11085
|
+
* @param identity
|
|
11086
|
+
* @param callerIdentity
|
|
11087
|
+
*/
|
|
11088
|
+
getWindowSnapshot(identity: OpenFin_2.Identity, callerIdentity: OpenFin_2.Identity): Promise<OpenFin_2.WindowCreationOptions>;
|
|
11139
11089
|
/* Excluded from this release type: getViewSnapshot */
|
|
11140
11090
|
/**
|
|
11141
11091
|
* Called when a snapshot is being applied and some windows in that snapshot would be fully or partially off-screen.
|
|
@@ -11540,19 +11490,9 @@ declare interface PlatformProvider {
|
|
|
11540
11490
|
}
|
|
11541
11491
|
|
|
11542
11492
|
/**
|
|
11543
|
-
*
|
|
11544
|
-
* @remarks The call is resolved when the following conditions are met for all windows in the snapshot:
|
|
11545
|
-
* 1. The window has been created
|
|
11546
|
-
* 2. The window has a responsive API
|
|
11547
|
-
* 3. If a window has a layout property, the 'layout-ready' event has fired
|
|
11548
|
-
*
|
|
11549
|
-
* _Note_ - In the case of using a custom provider, if a window has a layout property but does not call _Layout.init_ this event may not fire.
|
|
11550
|
-
* @interface
|
|
11493
|
+
* @deprecated Renamed to {@link SnapshotAppliedEvent}.
|
|
11551
11494
|
*/
|
|
11552
|
-
declare type PlatformSnapshotAppliedEvent =
|
|
11553
|
-
topic: 'application';
|
|
11554
|
-
type: 'platform-snapshot-applied';
|
|
11555
|
-
};
|
|
11495
|
+
declare type PlatformSnapshotAppliedEvent = SnapshotAppliedEvent;
|
|
11556
11496
|
|
|
11557
11497
|
/**
|
|
11558
11498
|
* @interface
|
|
@@ -11820,7 +11760,7 @@ declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent &
|
|
|
11820
11760
|
* A general preload scripts state change event without event type.
|
|
11821
11761
|
* @interface
|
|
11822
11762
|
*/
|
|
11823
|
-
declare type PreloadScriptsStateChangeEvent =
|
|
11763
|
+
declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
|
|
11824
11764
|
preloadScripts: (PreloadScriptInfoRunning & any)[];
|
|
11825
11765
|
};
|
|
11826
11766
|
|
|
@@ -12029,51 +11969,43 @@ declare type ProcessLoggingOptions = {
|
|
|
12029
11969
|
};
|
|
12030
11970
|
|
|
12031
11971
|
/**
|
|
12032
|
-
*
|
|
12033
|
-
* {@link OpenFin.ApplicationEvents.ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}
|
|
12034
|
-
* are propagated to `System` without any type string prefixing.
|
|
12035
|
-
*
|
|
12036
|
-
* "Requested" events (e.g. {@link RunRequestedEvent}) do not propagate.
|
|
11972
|
+
* @deprecated Renamed to {@link PropagatedEvent}.
|
|
12037
11973
|
*/
|
|
12038
|
-
declare type PropagatedApplicationEvent<TargetTopic extends string> =
|
|
11974
|
+
declare type PropagatedApplicationEvent<TargetTopic extends string> = PropagatedEvent_4<TargetTopic>;
|
|
12039
11975
|
|
|
12040
11976
|
/**
|
|
12041
|
-
*
|
|
11977
|
+
* @deprecated Renamed to {@link PropagatedEventType}.
|
|
12042
11978
|
*/
|
|
12043
|
-
declare type PropagatedApplicationEventType =
|
|
11979
|
+
declare type PropagatedApplicationEventType = PropagatedEventType_3;
|
|
12044
11980
|
|
|
12045
11981
|
/**
|
|
12046
|
-
* Modifies an event shape to reflect propagation to a parent topic.
|
|
11982
|
+
* Modifies an event shape to reflect propagation to a parent topic. Excludes `close-requested` events, as
|
|
11983
|
+
* these do not propagate.
|
|
11984
|
+
*
|
|
12047
11985
|
* @remarks The 'type' field is prefixed with the original topic, and a new property is added with the original topic's identity.
|
|
11986
|
+
*
|
|
11987
|
+
* @typeParam SourceTopic The topic the event shape is propagating from.
|
|
11988
|
+
* @typeParam TargetTopic The topic the event shape is propagating to.
|
|
11989
|
+
* @typeParam Event The shape of the event being propagated.
|
|
12048
11990
|
*/
|
|
12049
11991
|
declare type PropagatedEvent<SourceTopic extends string, TargetTopic extends string, Event extends {
|
|
12050
11992
|
type: string;
|
|
12051
11993
|
}> = Event extends infer E extends {
|
|
12052
11994
|
type: string;
|
|
12053
|
-
} ? Omit<E, 'type' | 'topic'> & {
|
|
11995
|
+
} ? E['type'] extends 'close-requested' ? never : Omit<E, 'type' | 'topic'> & {
|
|
12054
11996
|
type: PropagatedEventType<SourceTopic, E['type']>;
|
|
12055
11997
|
topic: TargetTopic;
|
|
12056
11998
|
} : never;
|
|
12057
11999
|
|
|
12058
|
-
/**
|
|
12059
|
-
* Modifies an event key to reflect propagation by prefixing with the topic.
|
|
12060
|
-
*/
|
|
12061
|
-
declare type PropagatedEventType<Topic extends string, Type extends string> = `${Topic}-${Type}`;
|
|
12062
|
-
|
|
12063
12000
|
/**
|
|
12064
12001
|
* A view event that has propagated to a parent {@link OpenFin.WindowEvents Window}, {@link OpenFin.ApplicationEvents Application},
|
|
12065
12002
|
* or {@link OpenFin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
|
|
12066
12003
|
* event type key with `'view-'`.
|
|
12067
12004
|
*/
|
|
12068
|
-
declare type
|
|
12005
|
+
declare type PropagatedEvent_2<TargetTopic extends string> = BaseEvents.PropagatedEvent<'view', TargetTopic, ViewEvent> & {
|
|
12069
12006
|
viewIdentity: OpenFin_2.Identity;
|
|
12070
12007
|
};
|
|
12071
12008
|
|
|
12072
|
-
/**
|
|
12073
|
-
* Union of possible `type` values for a {@link OpenFin.ViewEvents.PropagatedViewEvent}.
|
|
12074
|
-
*/
|
|
12075
|
-
declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
|
|
12076
|
-
|
|
12077
12009
|
/**
|
|
12078
12010
|
* A Window event that has propagated to the parent {@link OpenFin.ApplicationEvents Application} and {@link OpenFin.SystemEvents System},
|
|
12079
12011
|
* prefixing the type string with `'window-'`. Only {@link WindowSourcedEvent window-sourced events} will propagate
|
|
@@ -12082,12 +12014,51 @@ declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
|
|
|
12082
12014
|
*
|
|
12083
12015
|
* "Requested" events (e.g. {@link AuthRequestedEvent}) do not propagate to `System.`
|
|
12084
12016
|
*/
|
|
12085
|
-
declare type
|
|
12017
|
+
declare type PropagatedEvent_3<TargetTopic extends string> = BaseEvents.PropagatedEvent<'window', TargetTopic, WindowSourcedEvent>;
|
|
12018
|
+
|
|
12019
|
+
/**
|
|
12020
|
+
* An Application event that has propagated to {@link OpenFin.SystemEvents System}, type string prefixed with `application-`.
|
|
12021
|
+
* {@link OpenFin.ApplicationEvents.ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}
|
|
12022
|
+
* are propagated to `System` without any type string prefixing.
|
|
12023
|
+
*
|
|
12024
|
+
* "Requested" events (e.g. {@link RunRequestedEvent}) do not propagate.
|
|
12025
|
+
*/
|
|
12026
|
+
declare type PropagatedEvent_4<TargetTopic extends string> = BaseEvents.PropagatedEvent<'application', TargetTopic, ApplicationSourcedEvent> | ApplicationWindowEvent;
|
|
12086
12027
|
|
|
12087
12028
|
/**
|
|
12088
|
-
*
|
|
12029
|
+
* Modifies an event type key to reflect propagation by prefixing with the topic.
|
|
12089
12030
|
*/
|
|
12090
|
-
declare type
|
|
12031
|
+
declare type PropagatedEventType<Topic extends string, Type extends string> = `${Topic}-${NotCloseRequested<Type>}`;
|
|
12032
|
+
|
|
12033
|
+
/**
|
|
12034
|
+
* Union of possible `type` values for a {@link PropagatedEvent} sourced from a {@link OpenFin.View}.
|
|
12035
|
+
*/
|
|
12036
|
+
declare type PropagatedEventType_2 = PropagatedEvent_2<string>['type'];
|
|
12037
|
+
|
|
12038
|
+
/**
|
|
12039
|
+
* Union of possible 'type' values for an {@link PropagatedEvent} sourced from an {@link Application}.
|
|
12040
|
+
*/
|
|
12041
|
+
declare type PropagatedEventType_3 = PropagatedEvent_4<string>['type'];
|
|
12042
|
+
|
|
12043
|
+
/**
|
|
12044
|
+
* @deprecated Renamed to {@link PropagatedEvent}.
|
|
12045
|
+
*/
|
|
12046
|
+
declare type PropagatedViewEvent<TargetTopic extends string> = PropagatedEvent_2<TargetTopic>;
|
|
12047
|
+
|
|
12048
|
+
/**
|
|
12049
|
+
* @deprecated Renamed to {@link PropagatedEventType}.
|
|
12050
|
+
*/
|
|
12051
|
+
declare type PropagatedViewEventType = PropagatedEventType_2;
|
|
12052
|
+
|
|
12053
|
+
/**
|
|
12054
|
+
* @deprecated Renamed to {@link PropagatedEvent}.
|
|
12055
|
+
*/
|
|
12056
|
+
declare type PropagatedWindowEvent<TargetTopic extends string> = PropagatedEvent_3<TargetTopic>;
|
|
12057
|
+
|
|
12058
|
+
/**
|
|
12059
|
+
* Union of possible `type` values for a {@link PropagatedEvent} sourced from a {@link OpenFin.Window}.
|
|
12060
|
+
*/
|
|
12061
|
+
declare type PropagatedWindowEventType = PropagatedEvent_3<string>['type'];
|
|
12091
12062
|
|
|
12092
12063
|
declare interface ProtocolMap extends ProtocolMapBase {
|
|
12093
12064
|
'request-external-authorization': {
|
|
@@ -12505,7 +12476,7 @@ declare type RegistryInfo_2 = {
|
|
|
12505
12476
|
* Generated when a window has been reloaded.
|
|
12506
12477
|
* @interface
|
|
12507
12478
|
*/
|
|
12508
|
-
declare type ReloadedEvent =
|
|
12479
|
+
declare type ReloadedEvent = BaseEvent_5 & {
|
|
12509
12480
|
type: 'reloaded';
|
|
12510
12481
|
url: string;
|
|
12511
12482
|
};
|
|
@@ -12542,7 +12513,7 @@ declare type ReplaceLayoutPayload = {
|
|
|
12542
12513
|
/**
|
|
12543
12514
|
* Identity of the window whose layout will be replaced.
|
|
12544
12515
|
*/
|
|
12545
|
-
target: LayoutIdentity;
|
|
12516
|
+
target: Identity_5 | LayoutIdentity;
|
|
12546
12517
|
};
|
|
12547
12518
|
|
|
12548
12519
|
/**
|
|
@@ -12641,11 +12612,19 @@ declare type ResourceResponseReceivedEvent = NamedEvent & {
|
|
|
12641
12612
|
* Generated when an application is responding.
|
|
12642
12613
|
* @interface
|
|
12643
12614
|
*/
|
|
12644
|
-
declare type RespondingEvent = IdentityEvent & {
|
|
12615
|
+
declare type RespondingEvent = BaseEvents.IdentityEvent & {
|
|
12645
12616
|
topic: 'application';
|
|
12646
12617
|
type: 'responding';
|
|
12647
12618
|
};
|
|
12648
12619
|
|
|
12620
|
+
/**
|
|
12621
|
+
* Generated when a window is displayed after having been minimized or when a window leaves the maximize state without minimizing.
|
|
12622
|
+
* @interface
|
|
12623
|
+
*/
|
|
12624
|
+
declare type RestoredEvent = BaseEvent_5 & {
|
|
12625
|
+
type: 'restored';
|
|
12626
|
+
};
|
|
12627
|
+
|
|
12649
12628
|
declare type ResultBehavior = 'close' | 'hide' | 'none';
|
|
12650
12629
|
|
|
12651
12630
|
/**
|
|
@@ -12708,7 +12687,7 @@ declare type RunRequestedEvent = OpenFin_2.ApplicationEvents.RunRequestedEvent;
|
|
|
12708
12687
|
* Generated when Application.run() is called for an already running application.
|
|
12709
12688
|
* @interface
|
|
12710
12689
|
*/
|
|
12711
|
-
declare type RunRequestedEvent_2 = IdentityEvent & {
|
|
12690
|
+
declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
|
|
12712
12691
|
topic: 'application';
|
|
12713
12692
|
type: 'run-requested';
|
|
12714
12693
|
userAppConfigArgs: Record<string, any>;
|
|
@@ -12890,7 +12869,7 @@ declare type ServiceIdentifier = {
|
|
|
12890
12869
|
* Generated on changes to a user’s local computer session.
|
|
12891
12870
|
* @interface
|
|
12892
12871
|
*/
|
|
12893
|
-
declare type SessionChangedEvent =
|
|
12872
|
+
declare type SessionChangedEvent = BaseEvent_8 & {
|
|
12894
12873
|
type: 'session-changed';
|
|
12895
12874
|
reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
|
|
12896
12875
|
};
|
|
@@ -13112,7 +13091,7 @@ declare type ShortcutOverride = Hotkey & {
|
|
|
13112
13091
|
*
|
|
13113
13092
|
* @interface
|
|
13114
13093
|
*/
|
|
13115
|
-
declare type ShowAllDownloadsEvent =
|
|
13094
|
+
declare type ShowAllDownloadsEvent = BaseEvent_5 & {
|
|
13116
13095
|
type: 'show-all-downloads';
|
|
13117
13096
|
};
|
|
13118
13097
|
|
|
@@ -13120,7 +13099,15 @@ declare type ShowAllDownloadsEvent = BaseWindowEvent & {
|
|
|
13120
13099
|
* Generated when a View is shown. This event will fire during creation of a View.
|
|
13121
13100
|
* @interface
|
|
13122
13101
|
*/
|
|
13123
|
-
declare type ShownEvent =
|
|
13102
|
+
declare type ShownEvent = BaseEvent_4 & {
|
|
13103
|
+
type: 'shown';
|
|
13104
|
+
};
|
|
13105
|
+
|
|
13106
|
+
/**
|
|
13107
|
+
* Generated when a hidden window has been shown.
|
|
13108
|
+
* @interface
|
|
13109
|
+
*/
|
|
13110
|
+
declare type ShownEvent_2 = BaseEvent_5 & {
|
|
13124
13111
|
type: 'shown';
|
|
13125
13112
|
};
|
|
13126
13113
|
|
|
@@ -13149,6 +13136,15 @@ declare type ShowPopupMenuOptions<Data extends unknown = unknown> = {
|
|
|
13149
13136
|
y?: number;
|
|
13150
13137
|
};
|
|
13151
13138
|
|
|
13139
|
+
/**
|
|
13140
|
+
* Generated when a window has been prevented from showing.
|
|
13141
|
+
* @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.
|
|
13142
|
+
* @interface
|
|
13143
|
+
*/
|
|
13144
|
+
declare type ShowRequestedEvent = BaseEvent_5 & {
|
|
13145
|
+
type: 'show-requested';
|
|
13146
|
+
};
|
|
13147
|
+
|
|
13152
13148
|
/**
|
|
13153
13149
|
* _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
|
|
13154
13150
|
*
|
|
@@ -13195,6 +13191,21 @@ declare type Snapshot = {
|
|
|
13195
13191
|
};
|
|
13196
13192
|
};
|
|
13197
13193
|
|
|
13194
|
+
/**
|
|
13195
|
+
* Generated when a platform.ApplySnapshot call is resolved.
|
|
13196
|
+
* @remarks The call is resolved when the following conditions are met for all windows in the snapshot:
|
|
13197
|
+
* 1. The window has been created
|
|
13198
|
+
* 2. The window has a responsive API
|
|
13199
|
+
* 3. If a window has a layout property, the 'layout-ready' event has fired
|
|
13200
|
+
*
|
|
13201
|
+
* _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.
|
|
13202
|
+
* @interface
|
|
13203
|
+
*/
|
|
13204
|
+
declare type SnapshotAppliedEvent = BaseEvent & {
|
|
13205
|
+
topic: 'application';
|
|
13206
|
+
type: 'platform-snapshot-applied';
|
|
13207
|
+
};
|
|
13208
|
+
|
|
13198
13209
|
/**
|
|
13199
13210
|
* @interface
|
|
13200
13211
|
*/
|
|
@@ -13309,7 +13320,7 @@ declare class SnapshotSourceModule extends Base {
|
|
|
13309
13320
|
* Generated when an application has started.
|
|
13310
13321
|
* @interface
|
|
13311
13322
|
*/
|
|
13312
|
-
declare type StartedEvent = IdentityEvent & {
|
|
13323
|
+
declare type StartedEvent = BaseEvents.IdentityEvent & {
|
|
13313
13324
|
topic: 'application';
|
|
13314
13325
|
type: 'started';
|
|
13315
13326
|
};
|
|
@@ -13333,83 +13344,6 @@ declare type SubscriptionOptions = {
|
|
|
13333
13344
|
declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
13334
13345
|
/* Excluded from this release type: __constructor */
|
|
13335
13346
|
private sendExternalProcessRequest;
|
|
13336
|
-
/**
|
|
13337
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
|
13338
|
-
* @param eventType - The type of the event.
|
|
13339
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
|
13340
|
-
* @param options - Option to support event timestamps.
|
|
13341
|
-
*
|
|
13342
|
-
* @function addListener
|
|
13343
|
-
* @memberof System
|
|
13344
|
-
* @instance
|
|
13345
|
-
* @tutorial System.EventEmitter
|
|
13346
|
-
*/
|
|
13347
|
-
/**
|
|
13348
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
|
13349
|
-
* @param eventType - The type of the event.
|
|
13350
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
|
13351
|
-
* @param options - Option to support event timestamps.
|
|
13352
|
-
*
|
|
13353
|
-
* @function on
|
|
13354
|
-
* @memberof System
|
|
13355
|
-
* @instance
|
|
13356
|
-
* @tutorial System.EventEmitter
|
|
13357
|
-
*/
|
|
13358
|
-
/**
|
|
13359
|
-
* Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
|
|
13360
|
-
* @param eventType - The type of the event.
|
|
13361
|
-
* @param listener - The callback function.
|
|
13362
|
-
* @param options - Option to support event timestamps.
|
|
13363
|
-
*
|
|
13364
|
-
* @function once
|
|
13365
|
-
* @memberof System
|
|
13366
|
-
* @instance
|
|
13367
|
-
* @tutorial System.EventEmitter
|
|
13368
|
-
*/
|
|
13369
|
-
/**
|
|
13370
|
-
* Adds a listener to the beginning of the listeners array for the specified event.
|
|
13371
|
-
* @param eventType - The type of the event.
|
|
13372
|
-
* @param listener - The callback function.
|
|
13373
|
-
* @param options - Option to support event timestamps.
|
|
13374
|
-
*
|
|
13375
|
-
* @function prependListener
|
|
13376
|
-
* @memberof System
|
|
13377
|
-
* @instance
|
|
13378
|
-
* @tutorial System.EventEmitter
|
|
13379
|
-
*/
|
|
13380
|
-
/**
|
|
13381
|
-
* Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
|
|
13382
|
-
* The listener is added to the beginning of the listeners array.
|
|
13383
|
-
* @param eventType - The type of the event.
|
|
13384
|
-
* @param listener - The callback function.
|
|
13385
|
-
* @param options - Option to support event timestamps.
|
|
13386
|
-
*
|
|
13387
|
-
* @function prependOnceListener
|
|
13388
|
-
* @memberof System
|
|
13389
|
-
* @instance
|
|
13390
|
-
* @tutorial System.EventEmitter
|
|
13391
|
-
*/
|
|
13392
|
-
/**
|
|
13393
|
-
* Remove a listener from the listener array for the specified event.
|
|
13394
|
-
* Caution: Calling this method changes the array indices in the listener array behind the listener.
|
|
13395
|
-
* @param eventType - The type of the event.
|
|
13396
|
-
* @param listener - The callback function.
|
|
13397
|
-
* @param options - Option to support event timestamps.
|
|
13398
|
-
*
|
|
13399
|
-
* @function removeListener
|
|
13400
|
-
* @memberof System
|
|
13401
|
-
* @instance
|
|
13402
|
-
* @tutorial System.EventEmitter
|
|
13403
|
-
*/
|
|
13404
|
-
/**
|
|
13405
|
-
* Removes all listeners, or those of the specified event.
|
|
13406
|
-
* @param eventType - The type of the event.
|
|
13407
|
-
*
|
|
13408
|
-
* @function removeAllListeners
|
|
13409
|
-
* @memberof System
|
|
13410
|
-
* @instance
|
|
13411
|
-
* @tutorial System.EventEmitter
|
|
13412
|
-
*/
|
|
13413
13347
|
/**
|
|
13414
13348
|
* Returns the version of the runtime. The version contains the major, minor,
|
|
13415
13349
|
* build and revision numbers.
|
|
@@ -14842,12 +14776,9 @@ declare type SystemChannel = Omit<Channel_3, 'addContextListener' | 'broadcast'
|
|
|
14842
14776
|
};
|
|
14843
14777
|
|
|
14844
14778
|
/**
|
|
14845
|
-
*
|
|
14846
|
-
* discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
|
|
14847
|
-
* under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
|
14848
|
-
* from which they propagate).
|
|
14779
|
+
* @deprecated Renamed to {@link Event}.
|
|
14849
14780
|
*/
|
|
14850
|
-
declare type SystemEvent =
|
|
14781
|
+
declare type SystemEvent = Event_11;
|
|
14851
14782
|
|
|
14852
14783
|
declare type SystemEvent_2 = Events.SystemEvents.SystemEvent;
|
|
14853
14784
|
|
|
@@ -14855,8 +14786,10 @@ declare namespace SystemEvents {
|
|
|
14855
14786
|
export {
|
|
14856
14787
|
NotRequested,
|
|
14857
14788
|
ExcludeRequested,
|
|
14858
|
-
|
|
14789
|
+
BaseEvent_8 as BaseEvent,
|
|
14790
|
+
IdleStateChangedEvent,
|
|
14859
14791
|
IdleEvent,
|
|
14792
|
+
MonitorInfoChangedEvent,
|
|
14860
14793
|
MonitorEvent,
|
|
14861
14794
|
SessionChangedEvent,
|
|
14862
14795
|
AppVersionEvent,
|
|
@@ -14870,17 +14803,19 @@ declare namespace SystemEvents {
|
|
|
14870
14803
|
ApplicationCreatedEvent,
|
|
14871
14804
|
DesktopIconClickedEvent,
|
|
14872
14805
|
SystemShutdownEvent,
|
|
14806
|
+
Event_11 as Event,
|
|
14873
14807
|
SystemEvent,
|
|
14808
|
+
EventType_8 as EventType,
|
|
14874
14809
|
SystemEventType,
|
|
14875
|
-
|
|
14876
|
-
|
|
14810
|
+
Payload_9 as Payload,
|
|
14811
|
+
ByType_8 as ByType
|
|
14877
14812
|
}
|
|
14878
14813
|
}
|
|
14879
14814
|
|
|
14880
14815
|
/**
|
|
14881
|
-
*
|
|
14816
|
+
* @deprecated Renamed to {@link EventType}.
|
|
14882
14817
|
*/
|
|
14883
|
-
declare type SystemEventType =
|
|
14818
|
+
declare type SystemEventType = EventType_8;
|
|
14884
14819
|
|
|
14885
14820
|
/**
|
|
14886
14821
|
* @interface
|
|
@@ -14992,20 +14927,6 @@ declare interface TabDragListener extends EventEmitter_2 {
|
|
|
14992
14927
|
contentItem: ContentItem;
|
|
14993
14928
|
}
|
|
14994
14929
|
|
|
14995
|
-
/**
|
|
14996
|
-
* @typedef {string} LayoutPosition
|
|
14997
|
-
* @summary Represents the position of an item in a layout relative to another. Possible values are 'top', 'bottom', 'left' and 'right'.
|
|
14998
|
-
*/
|
|
14999
|
-
/**
|
|
15000
|
-
* @typedef {object} StackCreationOptions
|
|
15001
|
-
* @summary Stack creation options.
|
|
15002
|
-
* @property {LayoutPosition} [position] - The position to create the new {@link TabStack} in, relative to the given adjacent {@link TabStack}. Defaults to 'right'.
|
|
15003
|
-
*/
|
|
15004
|
-
/**
|
|
15005
|
-
* @typedef {object} TabStack~AddViewOptions
|
|
15006
|
-
* @summary Options to use when adding a view to a {@link TabStack}
|
|
15007
|
-
* @property {number} [index] - Insertion index when adding the view. Defaults to 0.
|
|
15008
|
-
*/
|
|
15009
14930
|
/**
|
|
15010
14931
|
* A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
|
|
15011
14932
|
*/
|
|
@@ -15133,7 +15054,7 @@ declare type TargetApp = string | AppMetadata;
|
|
|
15133
15054
|
* In that case, previousTarget identity will be the same as target identity.
|
|
15134
15055
|
* @interface
|
|
15135
15056
|
*/
|
|
15136
|
-
declare type TargetChangedEvent =
|
|
15057
|
+
declare type TargetChangedEvent = BaseEvent_4 & {
|
|
15137
15058
|
type: 'target-changed';
|
|
15138
15059
|
previousTarget: OpenFin_2.Identity;
|
|
15139
15060
|
};
|
|
@@ -15287,7 +15208,7 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
|
|
|
15287
15208
|
* Generated when the tray icon is clicked.
|
|
15288
15209
|
* @interface
|
|
15289
15210
|
*/
|
|
15290
|
-
declare type TrayIconClickedEvent = IdentityEvent & {
|
|
15211
|
+
declare type TrayIconClickedEvent = BaseEvents.IdentityEvent & {
|
|
15291
15212
|
topic: 'application';
|
|
15292
15213
|
type: 'tray-icon-clicked';
|
|
15293
15214
|
button: 0 | 1 | 2;
|
|
@@ -15377,7 +15298,7 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
|
|
|
15377
15298
|
* A general user bounds change event without event type.
|
|
15378
15299
|
* @interface
|
|
15379
15300
|
*/
|
|
15380
|
-
declare type UserBoundsChangeEvent =
|
|
15301
|
+
declare type UserBoundsChangeEvent = BaseEvent_5 & {
|
|
15381
15302
|
height: number;
|
|
15382
15303
|
left: number;
|
|
15383
15304
|
top: number;
|
|
@@ -15389,7 +15310,7 @@ declare type UserBoundsChangeEvent = BaseWindowEvent & {
|
|
|
15389
15310
|
* Generated when a window's user movement becomes disabled.
|
|
15390
15311
|
* @interface
|
|
15391
15312
|
*/
|
|
15392
|
-
declare type UserMovementDisabledEvent =
|
|
15313
|
+
declare type UserMovementDisabledEvent = BaseEvent_5 & {
|
|
15393
15314
|
type: 'user-movement-disabled';
|
|
15394
15315
|
};
|
|
15395
15316
|
|
|
@@ -15397,7 +15318,7 @@ declare type UserMovementDisabledEvent = BaseWindowEvent & {
|
|
|
15397
15318
|
* Generated when a window's user movement becomes enabled.
|
|
15398
15319
|
* @interface
|
|
15399
15320
|
*/
|
|
15400
|
-
declare type UserMovementEnabledEvent =
|
|
15321
|
+
declare type UserMovementEnabledEvent = BaseEvent_5 & {
|
|
15401
15322
|
type: 'user-movement-enabled';
|
|
15402
15323
|
};
|
|
15403
15324
|
|
|
@@ -15451,172 +15372,9 @@ declare type VerboseWebPermission = {
|
|
|
15451
15372
|
declare type View = OpenFin_2.View;
|
|
15452
15373
|
|
|
15453
15374
|
/**
|
|
15454
|
-
*
|
|
15455
|
-
*
|
|
15456
|
-
* @
|
|
15457
|
-
* @desc This is the options object required by {@link View.create View.create}.
|
|
15458
|
-
*
|
|
15459
|
-
* Note that `name` and `target` are the only required properties — albeit the `url` property is usually provided as well
|
|
15460
|
-
* (defaults to `"about:blank"` when omitted).
|
|
15461
|
-
*
|
|
15462
|
-
* @property {object} [experimental]
|
|
15463
|
-
* Configurations for API injection.
|
|
15464
|
-
*
|
|
15465
|
-
* @property {boolean} [experimental.childWindows] Configure if the runtime should enable child windows for views.
|
|
15466
|
-
*
|
|
15467
|
-
* @property {object} [accelerator]
|
|
15468
|
-
* Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
|
|
15469
|
-
*
|
|
15470
|
-
* @property {boolean} [accelerator.devtools=false]
|
|
15471
|
-
* If `true`, enables the devtools keyboard shortcut:<br>
|
|
15472
|
-
* `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
|
|
15473
|
-
*
|
|
15474
|
-
* @property {boolean} [accelerator.reload=false]
|
|
15475
|
-
* If `true`, enables the reload keyboard shortcuts:<br>
|
|
15476
|
-
* `Ctrl` + `R` _(Windows)_<br>
|
|
15477
|
-
* `F5` _(Windows)_<br>
|
|
15478
|
-
* `Command` + `R` _(Mac)_
|
|
15479
|
-
*
|
|
15480
|
-
* @property {boolean} [accelerator.reloadIgnoringCache=false]
|
|
15481
|
-
* If `true`, enables the reload-from-source keyboard shortcuts:<br>
|
|
15482
|
-
* `Ctrl` + `Shift` + `R` _(Windows)_<br>
|
|
15483
|
-
* `Shift` + `F5` _(Windows)_<br>
|
|
15484
|
-
* `Command` + `Shift` + `R` _(Mac)_
|
|
15485
|
-
*
|
|
15486
|
-
* @property {boolean} [accelerator.zoom=false]
|
|
15487
|
-
* If `true`, enables the zoom keyboard shortcuts:<br>
|
|
15488
|
-
* `Ctrl` + `+` _(Zoom In)_<br>
|
|
15489
|
-
* `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
|
|
15490
|
-
* `Ctrl` + `NumPad+` _(Zoom In)_<br>
|
|
15491
|
-
* `Ctrl` + `-` _(Zoom Out)_<br>
|
|
15492
|
-
* `Ctrl` + `Shift` + `-` _(Zoom Out)_<br>
|
|
15493
|
-
* `Ctrl` + `NumPad-` _(Zoom Out)_<br>
|
|
15494
|
-
* `Ctrl` + `Scroll` _(Zoom In & Out)_<br>
|
|
15495
|
-
* `Ctrl` + `0` _(Restore to 100%)_
|
|
15496
|
-
*
|
|
15497
|
-
* @property {object} [api]
|
|
15498
|
-
* Configurations for API injection.
|
|
15499
|
-
*
|
|
15500
|
-
* @property {object} [api.iframe] Configure if the the API should be injected into iframes based on domain.
|
|
15501
|
-
*
|
|
15502
|
-
* @property {boolean} [api.iframe.crossOriginInjection=false] Controls if the `fin` API object is present for cross origin iframes.
|
|
15503
|
-
* @property {boolean} [api.iframe.sameOriginInjection=true] Controls if the `fin` API object is present for same origin iframes.
|
|
15504
|
-
*
|
|
15505
|
-
* @property {string} [autoplayPolicy="no-user-gesture-required"]
|
|
15506
|
-
* Autoplay policy to apply to content in the window, can be
|
|
15507
|
-
* `no-user-gesture-required`, `user-gesture-required`,
|
|
15508
|
-
* `document-user-activation-required`. Defaults to `no-user-gesture-required`.
|
|
15509
|
-
*
|
|
15510
|
-
* @property {object} [autoResize] AutoResize options
|
|
15511
|
-
*
|
|
15512
|
-
* @property {object} [bounds] initial bounds given relative to the window.
|
|
15513
|
-
*
|
|
15514
|
-
* @property {string} [backgroundColor="#FFF"] - _Updatable._
|
|
15515
|
-
* The view’s _backfill_ color as a hexadecimal value. Not to be confused with the content background color
|
|
15516
|
-
* (`document.body.style.backgroundColor`),
|
|
15517
|
-
* this color briefly fills a view’s (a) content area before its content is loaded as well as (b) newly exposed
|
|
15518
|
-
* areas when growing a window. Setting
|
|
15519
|
-
* this value to the anticipated content background color can help improve user experience.
|
|
15520
|
-
* Default is white.
|
|
15521
|
-
*
|
|
15522
|
-
* @property {object} [contentNavigation]
|
|
15523
|
-
* Restrict navigation to URLs that match an allowed pattern.
|
|
15524
|
-
* In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
|
|
15525
|
-
* See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
|
|
15526
|
-
* @property {string[]} [contentNavigation.allowlist=[]] List of allowed URLs.
|
|
15527
|
-
* @property {string[]} [contentNavigation.denylist=[]] List of denied URLs.
|
|
15528
|
-
*
|
|
15529
|
-
* @property {object} [contentRedirect]
|
|
15530
|
-
* Restrict redirects to URLs that match an allowed pattern.
|
|
15531
|
-
* In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
|
|
15532
|
-
* See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
|
|
15533
|
-
* @property {string[]} [contentRedirect.allowlist=[]] List of allowed URLs.
|
|
15534
|
-
* @property {string[]} [contentRedirect.denylist=[]] List of denied URLs.
|
|
15535
|
-
*
|
|
15536
|
-
* @property {object} [contextMenuSettings] - _Updatable._
|
|
15537
|
-
* Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
|
|
15538
|
-
* Configure the context menu when right-clicking on a view.
|
|
15539
|
-
* @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
|
|
15540
|
-
* @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
|
|
15541
|
-
* @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
|
|
15542
|
-
*
|
|
15543
|
-
* @property {object} [contextMenuOptions] - _Updatable._
|
|
15544
|
-
* Configure the context menu when right-clicking on a view. Supported menu items:
|
|
15545
|
-
* 'separator'
|
|
15546
|
-
* 'cut'
|
|
15547
|
-
* 'copy'
|
|
15548
|
-
* 'copyImage',
|
|
15549
|
-
* 'paste'
|
|
15550
|
-
* 'spellCheck'
|
|
15551
|
-
* 'inspect'
|
|
15552
|
-
* 'reload'
|
|
15553
|
-
* 'navigateForward'
|
|
15554
|
-
* 'navigateBack'
|
|
15555
|
-
* 'print'
|
|
15556
|
-
* @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
|
|
15557
|
-
* @property {string[]} [contextMenuOptions.template=[]] List of context menu items to display on right-click.
|
|
15558
|
-
*
|
|
15559
|
-
* @property {any} [customData=""] - _Updatable._
|
|
15560
|
-
* A field that the user can attach serializable data to be ferried around with the view options.
|
|
15561
|
-
* _When omitted, the default value of this property is the empty string (`""`)._
|
|
15562
|
-
*
|
|
15563
|
-
* @property {any} [customContext=""] - _Updatable._
|
|
15564
|
-
* A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
|
|
15565
|
-
* is called.
|
|
15566
|
-
* When omitted, the default value of this property is the empty string (`""`).
|
|
15567
|
-
* As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
|
|
15568
|
-
*
|
|
15569
|
-
* @property {object[]} [hotkeys=[]] - _Updatable._
|
|
15570
|
-
* Defines the list of hotkeys that will be emitted as a `hotkey` event on the view. For usage example see [example]{@tutorial hotkeys}.
|
|
15571
|
-
* Within Platform, OpenFin also implements a set of pre-defined actions called
|
|
15572
|
-
* [keyboard commands]{@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands}
|
|
15573
|
-
* that can be assigned to a specific hotkey in the platform manifest.
|
|
15574
|
-
* @property {string} hotkeys.keys The key combination of the hotkey, i.e. "Ctrl+T"
|
|
15575
|
-
* @property {boolean} [hotkeys.preventDefault=false] preventDefault will prevent the page keydown/keyup events from being emitted.
|
|
15576
|
-
*
|
|
15577
|
-
* @property {boolean} [isClosable=true] **Platforms Only.** If false, the view will be persistent and can't be closed through
|
|
15578
|
-
* either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
|
|
15579
|
-
* if the view isn't part of the new layout when running `Layout.replace`.
|
|
15580
|
-
*
|
|
15581
|
-
* @property {string} name
|
|
15582
|
-
* The name of the view.
|
|
15583
|
-
*
|
|
15584
|
-
* @property {boolean} [detachOnClose=false] - _Updatable._
|
|
15585
|
-
* Platforms Only. If true, will hide and detach the View from the window for later use instead of closing,
|
|
15586
|
-
* allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
|
|
15587
|
-
*
|
|
15588
|
-
* @property {string} [manifestUrl] **Platforms Only.** Url to a manifest that contains View Options. Properties other than manifestUrl can still be used
|
|
15589
|
-
* but the properties in the manifest will take precedence if there is any collision.
|
|
15590
|
-
*
|
|
15591
|
-
* @property {preloadScript[]} [preloadScripts] - _Inheritable_
|
|
15592
|
-
* A list of scripts that are eval'ed before other scripts in the page. When omitted, _inherits_
|
|
15593
|
-
* from the parent application.
|
|
15594
|
-
*
|
|
15595
|
-
* @property {boolean} [preventDragOut=false] **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
|
|
15596
|
-
*
|
|
15597
|
-
* @property {string} [processAffinity=<application uuid>]
|
|
15598
|
-
* A string to attempt to group renderers together. Will only be used if pages are on the same origin.
|
|
15599
|
-
*
|
|
15600
|
-
* @property {boolean} [spellCheck=false]
|
|
15601
|
-
* Enable spell check in input text fields for the view.
|
|
15602
|
-
*
|
|
15603
|
-
* @property {Identity} [target]
|
|
15604
|
-
* The identity of the window this view should be attached to.
|
|
15605
|
-
*
|
|
15606
|
-
* @property {string} [url="about:blank"]
|
|
15607
|
-
* The URL of the view.
|
|
15608
|
-
*
|
|
15609
|
-
* @property {string} [uuid=<application uuid>]
|
|
15610
|
-
* The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
|
|
15611
|
-
* If omitted, defaults to the `uuid` of the application spawning the view.
|
|
15612
|
-
* If given, must match the `uuid` of the application spawning the view.
|
|
15613
|
-
* In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
|
|
15614
|
-
* really no need to provide it.
|
|
15615
|
-
*/
|
|
15616
|
-
/**
|
|
15617
|
-
* A View can be used to embed additional web content into a Window.
|
|
15618
|
-
* It is like a child window, except it is positioned relative to its owning window.
|
|
15619
|
-
* It has the ability to listen for {@link OpenFin.ViewEvents View-specific events}.
|
|
15375
|
+
* A View can be used to embed additional web content into a Window.
|
|
15376
|
+
* It is like a child window, except it is positioned relative to its owning window.
|
|
15377
|
+
* It has the ability to listen for {@link OpenFin.ViewEvents View-specific events}.
|
|
15620
15378
|
*
|
|
15621
15379
|
* By default, a View will try to share the same renderer process as other Views owned by its parent Application.
|
|
15622
15380
|
* To change that behavior, see the processAffinity {@link OpenFin.ViewOptions view option}.
|
|
@@ -16047,7 +15805,7 @@ declare class View_2 extends WebContents<OpenFin_2.ViewEvent> {
|
|
|
16047
15805
|
* Generated when a View is attached to a window.
|
|
16048
15806
|
* @interface
|
|
16049
15807
|
*/
|
|
16050
|
-
declare type ViewAttachedEvent =
|
|
15808
|
+
declare type ViewAttachedEvent = BaseEvent_5 & {
|
|
16051
15809
|
type: 'view-attached';
|
|
16052
15810
|
target: OpenFin_2.Identity;
|
|
16053
15811
|
viewIdentity: OpenFin_2.Identity;
|
|
@@ -16089,26 +15847,23 @@ declare type ViewCreationOrReference = OpenFin_2.Identity | OpenFin_2.PlatformVi
|
|
|
16089
15847
|
* @remarks Will fire when a view is destroyed in which case `target` will be null.
|
|
16090
15848
|
* @interface
|
|
16091
15849
|
*/
|
|
16092
|
-
declare type ViewDetachedEvent =
|
|
15850
|
+
declare type ViewDetachedEvent = BaseEvent_5 & {
|
|
16093
15851
|
type: 'view-detached';
|
|
16094
|
-
target: OpenFin_2.Identity;
|
|
15852
|
+
target: OpenFin_2.Identity | null;
|
|
16095
15853
|
previousTarget: OpenFin_2.Identity;
|
|
16096
15854
|
viewIdentity: OpenFin_2.Identity;
|
|
16097
15855
|
};
|
|
16098
15856
|
|
|
16099
15857
|
/**
|
|
16100
|
-
*
|
|
16101
|
-
* discriminated by {@link ViewEvent.type | their type}. Event payloads unique to `View` can be found
|
|
16102
|
-
* under the {@link OpenFin.ViewEvents} namespace (except for {@link OpenFin.WebContentsEvents | those shared with other WebContents}).
|
|
15858
|
+
* @deprecated Renamed to {@link Event}.
|
|
16103
15859
|
*/
|
|
16104
|
-
declare type ViewEvent =
|
|
16105
|
-
target: OpenFin_2.Identity;
|
|
16106
|
-
}) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
|
|
15860
|
+
declare type ViewEvent = Event_4;
|
|
16107
15861
|
|
|
16108
15862
|
declare type ViewEvent_2 = Events.ViewEvents.ViewEvent;
|
|
16109
15863
|
|
|
16110
15864
|
declare namespace ViewEvents {
|
|
16111
15865
|
export {
|
|
15866
|
+
BaseEvent_4 as BaseEvent,
|
|
16112
15867
|
BaseViewEvent,
|
|
16113
15868
|
TargetChangedEvent,
|
|
16114
15869
|
NonPropagatedViewEvent,
|
|
@@ -16118,20 +15873,24 @@ declare namespace ViewEvents {
|
|
|
16118
15873
|
HotkeyEvent,
|
|
16119
15874
|
ShownEvent,
|
|
16120
15875
|
HostContextChangedEvent,
|
|
15876
|
+
Event_4 as Event,
|
|
16121
15877
|
ViewEvent,
|
|
16122
15878
|
WillPropagateViewEvent,
|
|
15879
|
+
EventType,
|
|
16123
15880
|
ViewEventType,
|
|
15881
|
+
PropagatedEvent_2 as PropagatedEvent,
|
|
16124
15882
|
PropagatedViewEvent,
|
|
15883
|
+
PropagatedEventType_2 as PropagatedEventType,
|
|
16125
15884
|
PropagatedViewEventType,
|
|
16126
|
-
|
|
16127
|
-
|
|
15885
|
+
Payload_2 as Payload,
|
|
15886
|
+
ByType
|
|
16128
15887
|
}
|
|
16129
15888
|
}
|
|
16130
15889
|
|
|
16131
15890
|
/**
|
|
16132
|
-
*
|
|
15891
|
+
* @deprecated Renamed to {@link EventType}.
|
|
16133
15892
|
*/
|
|
16134
|
-
declare type ViewEventType =
|
|
15893
|
+
declare type ViewEventType = EventType;
|
|
16135
15894
|
|
|
16136
15895
|
/**
|
|
16137
15896
|
* @interface
|
|
@@ -17270,12 +17029,9 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17270
17029
|
}
|
|
17271
17030
|
|
|
17272
17031
|
/**
|
|
17273
|
-
*
|
|
17274
|
-
* (i.e. {@link OpenFin.Window} or {@link OpenFin.View}).
|
|
17032
|
+
* @deprecated Renamed to {@link Event}.
|
|
17275
17033
|
*/
|
|
17276
|
-
declare type WebContentsEvent<Topic extends string> =
|
|
17277
|
-
topic: Topic;
|
|
17278
|
-
} & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | FaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent);
|
|
17034
|
+
declare type WebContentsEvent<Topic extends string> = Event_5<Topic>;
|
|
17279
17035
|
|
|
17280
17036
|
declare type WebContentsEvent_2<Topic extends string> = Events.WebContentsEvents.WebContentsEvent<Topic>;
|
|
17281
17037
|
|
|
@@ -17287,6 +17043,7 @@ declare namespace WebContentsEvents {
|
|
|
17287
17043
|
CrashedEvent_2 as CrashedEvent,
|
|
17288
17044
|
CertificateErrorEvent,
|
|
17289
17045
|
CertificateSelectionShownEvent,
|
|
17046
|
+
PageFaviconUpdatedEvent,
|
|
17290
17047
|
FaviconUpdatedEvent,
|
|
17291
17048
|
NavigationRejectedEvent,
|
|
17292
17049
|
UrlChangedEvent,
|
|
@@ -17305,6 +17062,7 @@ declare namespace WebContentsEvents {
|
|
|
17305
17062
|
FileDownloadStartedEvent,
|
|
17306
17063
|
FileDownloadProgressEvent,
|
|
17307
17064
|
FileDownloadCompletedEvent,
|
|
17065
|
+
Event_5 as Event,
|
|
17308
17066
|
WebContentsEvent,
|
|
17309
17067
|
WillPropagateWebContentsEvent,
|
|
17310
17068
|
NonPropagatedWebContentsEvent
|
|
@@ -17327,7 +17085,7 @@ declare namespace WebContentsEvents {
|
|
|
17327
17085
|
* `clipboard-read`: Request access to read from the clipboard.<br>
|
|
17328
17086
|
* `clipboard-sanitized-write`: Request access to write to the clipboard.
|
|
17329
17087
|
*/
|
|
17330
|
-
declare type WebPermission = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write' | OpenExternalPermission;
|
|
17088
|
+
declare type WebPermission = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write' | 'hid' | 'usb' | OpenExternalPermission;
|
|
17331
17089
|
|
|
17332
17090
|
/**
|
|
17333
17091
|
* Object representing headers and their values, where the
|
|
@@ -17352,7 +17110,7 @@ declare type WillMoveEvent = WillMoveOrResizeEvent & {
|
|
|
17352
17110
|
* A general will-move or will-resize event without event type.
|
|
17353
17111
|
* @interface
|
|
17354
17112
|
*/
|
|
17355
|
-
declare type WillMoveOrResizeEvent =
|
|
17113
|
+
declare type WillMoveOrResizeEvent = BaseEvent_5 & {
|
|
17356
17114
|
height: number;
|
|
17357
17115
|
left: number;
|
|
17358
17116
|
top: number;
|
|
@@ -17374,7 +17132,7 @@ declare type WillPropagateViewEvent = ViewEvent;
|
|
|
17374
17132
|
*
|
|
17375
17133
|
* A WebContents event that does propagate to (republish on) parent topics.
|
|
17376
17134
|
*/
|
|
17377
|
-
declare type WillPropagateWebContentsEvent =
|
|
17135
|
+
declare type WillPropagateWebContentsEvent = Event_5<string>;
|
|
17378
17136
|
|
|
17379
17137
|
/**
|
|
17380
17138
|
* @DEPRECATED all Window events propagate, so this is redundant - left as a convenience shim to avoid breaking
|
|
@@ -17388,7 +17146,7 @@ declare type WillPropagateWindowEvent = WindowSourcedEvent;
|
|
|
17388
17146
|
* Generated when window is being redirected as per contentRedirect allowlist/denylist rules.
|
|
17389
17147
|
* @interface
|
|
17390
17148
|
*/
|
|
17391
|
-
declare type WillRedirectEvent =
|
|
17149
|
+
declare type WillRedirectEvent = BaseEvent_5 & {
|
|
17392
17150
|
type: 'will-redirect';
|
|
17393
17151
|
blocked: boolean;
|
|
17394
17152
|
isInPlace: boolean;
|
|
@@ -17405,476 +17163,6 @@ declare type WillResizeEvent = WillMoveOrResizeEvent & {
|
|
|
17405
17163
|
type: 'will-resize';
|
|
17406
17164
|
};
|
|
17407
17165
|
|
|
17408
|
-
/**
|
|
17409
|
-
* @PORTED
|
|
17410
|
-
* @typedef { object } Margins@typedef { object } Margins
|
|
17411
|
-
* @property { string } [marginType]
|
|
17412
|
-
* Can be `default`, `none`, `printableArea`, or `custom`. If `custom` is chosen,
|
|
17413
|
-
* you will also need to specify `top`, `bottom`, `left`, and `right`.
|
|
17414
|
-
*
|
|
17415
|
-
* @property { number } [top] The top margin of the printed web page, in pixels.
|
|
17416
|
-
* @property { number } [bottom] The bottom margin of the printed web page, in pixels.
|
|
17417
|
-
* @property { number } [left] The left margin of the printed web page, in pixels.
|
|
17418
|
-
* @property { number } [right] The right margin of the printed web page, in pixels.
|
|
17419
|
-
*/
|
|
17420
|
-
/**
|
|
17421
|
-
* @PORTED
|
|
17422
|
-
* @typedef { object } Dpi@typedef { object } Dpi
|
|
17423
|
-
* @property { number } [horizontal] The horizontal dpi
|
|
17424
|
-
* @property { number } [vertical] The vertical dpi
|
|
17425
|
-
*/
|
|
17426
|
-
/**
|
|
17427
|
-
* @PORTED
|
|
17428
|
-
* @typedef { object } PrintOptions@typedef { object } PrintOptions
|
|
17429
|
-
* @property { boolean } [silent=false] Don't ask user for print settings.
|
|
17430
|
-
* @property { boolean } [printBackground=false] Prints the background color and image of the web page.
|
|
17431
|
-
* @property { string } [deviceName=''] Set the printer device name to use.
|
|
17432
|
-
* @property { boolean } [color=true] Set whether the printed web page will be in color or grayscale.
|
|
17433
|
-
* @property { Margins } [margins] Set margins for the printed web page
|
|
17434
|
-
* @property { boolean } [landscape=false] Whether the web page should be printed in landscape mode.
|
|
17435
|
-
* @property { number } [scaleFactor] The scale factor of the web page.
|
|
17436
|
-
* @property { number } [pagesPerSheet] The number of pages to print per page sheet.
|
|
17437
|
-
* @property { boolean } [collate] Whether the web page should be collated.
|
|
17438
|
-
* @property { number } [copies] The number of copies of the web page to print.
|
|
17439
|
-
* @property { Record<string, number> } [pageRanges] The page range to print. Should have two keys: from and to.
|
|
17440
|
-
* @property { string } [duplexMode] Set the duplex mode of the printed web page. Can be simplex, shortEdge, or longEdge.
|
|
17441
|
-
* @property { Dpi } [dpi] Set dpi for the printed web page
|
|
17442
|
-
*/
|
|
17443
|
-
/**
|
|
17444
|
-
* @REMOVED
|
|
17445
|
-
* PrinterInfo interface
|
|
17446
|
-
* @typedef { object } PrinterInfo@typedef { object } PrinterInfo
|
|
17447
|
-
* @property { string } name Printer Name
|
|
17448
|
-
* @property { string } description Printer Description
|
|
17449
|
-
* @property { number } status Printer Status
|
|
17450
|
-
* @property { boolean } isDefault Indicates that system's default printer
|
|
17451
|
-
*/
|
|
17452
|
-
/**
|
|
17453
|
-
* @REMOVED
|
|
17454
|
-
* SharedWorkerInfo interface
|
|
17455
|
-
* @typedef { object } SharedWorkerInfo@typedef { object } SharedWorkerInfo
|
|
17456
|
-
* @property { string } id The unique id of the shared worker.
|
|
17457
|
-
* @property { string } url The url of the shared worker.
|
|
17458
|
-
*/
|
|
17459
|
-
/**
|
|
17460
|
-
* @PORTED
|
|
17461
|
-
* ContentCreationRule interface
|
|
17462
|
-
* @typedef { object } ContentCreationRule@typedef { object } ContentCreationRule
|
|
17463
|
-
* @property { string } behavior 'view' | 'window' | 'browser' | 'block'
|
|
17464
|
-
* @property { string[] } match List of [match patterns](https://developer.chrome.com/extensions/match_patterns).
|
|
17465
|
-
* @property { object } options Window creation options or View creation options.
|
|
17466
|
-
*/
|
|
17467
|
-
/**
|
|
17468
|
-
* @PORTED
|
|
17469
|
-
* @typedef {object} Window~options
|
|
17470
|
-
* @summary Window creation options.
|
|
17471
|
-
* @desc This is the options object required by {@link Window.create Window.create}.
|
|
17472
|
-
*
|
|
17473
|
-
* Note that `name` is the only required property — albeit the `url` property is usually provided as well
|
|
17474
|
-
* (defaults to `"about:blank"` when omitted).
|
|
17475
|
-
*
|
|
17476
|
-
* _This jsdoc typedef mirrors the `WindowOptions` TypeScript interface in `@types/openfin`._
|
|
17477
|
-
*
|
|
17478
|
-
* @property {object} [accelerator]
|
|
17479
|
-
* Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
|
|
17480
|
-
*
|
|
17481
|
-
* @property {boolean} [accelerator.devtools=false]
|
|
17482
|
-
* If `true`, enables the devtools keyboard shortcut:<br>
|
|
17483
|
-
* `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
|
|
17484
|
-
*
|
|
17485
|
-
* @property {boolean} [accelerator.reload=false]
|
|
17486
|
-
* If `true`, enables the reload keyboard shortcuts:<br>
|
|
17487
|
-
* `Ctrl` + `R` _(Windows)_<br>
|
|
17488
|
-
* `F5` _(Windows)_<br>
|
|
17489
|
-
* `Command` + `R` _(Mac)_
|
|
17490
|
-
*
|
|
17491
|
-
* @property {boolean} [accelerator.reloadIgnoringCache=false]
|
|
17492
|
-
* If `true`, enables the reload-from-source keyboard shortcuts:<br>
|
|
17493
|
-
* `Ctrl` + `Shift` + `R` _(Windows)_<br>
|
|
17494
|
-
* `Shift` + `F5` _(Windows)_<br>
|
|
17495
|
-
* `Command` + `Shift` + `R` _(Mac)_
|
|
17496
|
-
*
|
|
17497
|
-
* @property {boolean} [accelerator.zoom=false]
|
|
17498
|
-
* NOTE: It is not recommended to set this value to true for Windows in Platforms as that may lead to unexpected visual shifts in layout.
|
|
17499
|
-
* If `true`, enables the zoom keyboard shortcuts:<br>
|
|
17500
|
-
* `Ctrl` + `+` _(Zoom In)_<br>
|
|
17501
|
-
* `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
|
|
17502
|
-
* `Ctrl` + `NumPad+` _(Zoom In)_<br>
|
|
17503
|
-
* `Ctrl` + `-` _(Zoom Out)_<br>
|
|
17504
|
-
* `Ctrl` + `Shift` + `-` _(Zoom Out)_<br>
|
|
17505
|
-
* `Ctrl` + `NumPad-` _(Zoom Out)_<br>
|
|
17506
|
-
* `Ctrl` + `Scroll` _(Zoom In & Out)_<br>
|
|
17507
|
-
* `Ctrl` + `0` _(Restore to 100%)_
|
|
17508
|
-
*
|
|
17509
|
-
* @property {object} [alphaMask] - _Experimental._ _Updatable._
|
|
17510
|
-
* <br>
|
|
17511
|
-
* alphaMask turns anything of matching RGB value transparent.
|
|
17512
|
-
* <br>
|
|
17513
|
-
* Caveats:
|
|
17514
|
-
* * Runtime flags --disable-gpu and --allow-unsafe-compositing are required. Note: Unclear behavior on remote Desktop support
|
|
17515
|
-
* * User cannot click-through transparent regions
|
|
17516
|
-
* * Not supported on Mac
|
|
17517
|
-
* * Windows Aero must be enabled
|
|
17518
|
-
* * Won't make visual sense on Pixel-pushed environments such as Citrix
|
|
17519
|
-
* * Not supported on rounded corner windows
|
|
17520
|
-
* @property {number} [alphaMask.red=-1] 0-255
|
|
17521
|
-
* @property {number} [alphaMask.green=-1] 0-255
|
|
17522
|
-
* @property {number} [alphaMask.blue=-1] 0-255
|
|
17523
|
-
*
|
|
17524
|
-
* @property {boolean} [alwaysOnTop=false] - _Updatable._
|
|
17525
|
-
* A flag to always position the window at the top of the window stack.
|
|
17526
|
-
*
|
|
17527
|
-
* @property {object} [api]
|
|
17528
|
-
* Configurations for API injection.
|
|
17529
|
-
*
|
|
17530
|
-
* @property {object} [api.iframe] Configure if the the API should be injected into iframes based on domain.
|
|
17531
|
-
*
|
|
17532
|
-
* @property {boolean} [api.iframe.crossOriginInjection=false] Controls if the `fin` API object is present for cross origin iframes.
|
|
17533
|
-
* @property {boolean} [api.iframe.sameOriginInjection=true] Controls if the `fin` API object is present for same origin iframes.
|
|
17534
|
-
*
|
|
17535
|
-
* @property {string} [applicationIcon = ""] - _Deprecated_ - use `icon` instead.
|
|
17536
|
-
*
|
|
17537
|
-
* @property {number} [aspectRatio=0] - _Updatable._
|
|
17538
|
-
* The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
|
|
17539
|
-
* an aspect ratio will not be enforced.
|
|
17540
|
-
*
|
|
17541
|
-
* @property {string} [autoplayPolicy="no-user-gesture-required"]
|
|
17542
|
-
* Autoplay policy to apply to content in the window, can be
|
|
17543
|
-
* `no-user-gesture-required`, `user-gesture-required`,
|
|
17544
|
-
* `document-user-activation-required`. Defaults to `no-user-gesture-required`.
|
|
17545
|
-
*
|
|
17546
|
-
* @property {boolean} [autoShow=true]
|
|
17547
|
-
* A flag to automatically show the window when it is created.
|
|
17548
|
-
*
|
|
17549
|
-
* @property {string} [backgroundColor="#FFF"]
|
|
17550
|
-
* The window’s _backfill_ color as a hexadecimal value. Not to be confused with the content background color
|
|
17551
|
-
* (`document.body.style.backgroundColor`),
|
|
17552
|
-
* this color briefly fills a window’s (a) content area before its content is loaded as well as (b) newly exposed
|
|
17553
|
-
* areas when growing a window. Setting
|
|
17554
|
-
* this value to the anticipated content background color can help improve user experience.
|
|
17555
|
-
* Default is white.
|
|
17556
|
-
*
|
|
17557
|
-
* @property {object} [contentCreation]
|
|
17558
|
-
* Apply rules that determine how user interaction (`window.open` and links) creates content.
|
|
17559
|
-
* @property {ContentCreationRule[]} [contentCreation.rules = []] List of content creation rules.
|
|
17560
|
-
*
|
|
17561
|
-
* @property {object} [contentNavigation]
|
|
17562
|
-
* Restrict navigation to URLs that match an allowed pattern.
|
|
17563
|
-
* In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
|
|
17564
|
-
* See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
|
|
17565
|
-
* @property {string[]} [contentNavigation.allowlist=[]] List of allowed URLs.
|
|
17566
|
-
* @property {string[]} [contentNavigation.denylist=[]] List of denied URLs.
|
|
17567
|
-
*
|
|
17568
|
-
* @property {object} [contentRedirect]
|
|
17569
|
-
* Restrict redirects to URLs that match an allowed pattern.
|
|
17570
|
-
* In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
|
|
17571
|
-
* See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
|
|
17572
|
-
* @property {string[]} [contentRedirect.allowlist=[]] List of allowed URLs.
|
|
17573
|
-
* @property {string[]} [contentRedirect.denylist=[]] List of denied URLs.
|
|
17574
|
-
*
|
|
17575
|
-
* @property {boolean} [contextMenu=true] - _Updatable._
|
|
17576
|
-
* A flag to show the context menu when right-clicking on a window.
|
|
17577
|
-
* Gives access to the devtools for the window.
|
|
17578
|
-
*
|
|
17579
|
-
* @property {object} [contextMenuSettings] - _Updatable._
|
|
17580
|
-
* Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
|
|
17581
|
-
* Configure the context menu when right-clicking on a window.
|
|
17582
|
-
* @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
|
|
17583
|
-
* @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
|
|
17584
|
-
* @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
|
|
17585
|
-
*
|
|
17586
|
-
* @property {object} [contextMenuOptions] - _Updatable._
|
|
17587
|
-
* Configure the context menu when right-clicking on a window. Supported menu items:
|
|
17588
|
-
* 'separator'
|
|
17589
|
-
* 'cut'
|
|
17590
|
-
* 'copy'
|
|
17591
|
-
* 'paste'
|
|
17592
|
-
* 'spellCheck'
|
|
17593
|
-
* 'inspect'
|
|
17594
|
-
* 'reload'
|
|
17595
|
-
* 'navigateForward'
|
|
17596
|
-
* 'navigateBack'
|
|
17597
|
-
* 'print'
|
|
17598
|
-
* @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
|
|
17599
|
-
* @property {string[]} [contextMenuSettings.template=[]] List of context menu items to display on right-click.
|
|
17600
|
-
*
|
|
17601
|
-
* @property {object} [cornerRounding] - _Updatable._
|
|
17602
|
-
* Defines and applies rounded corners for a frameless window. **NOTE:** On macOS corner is not ellipse but circle rounded by the
|
|
17603
|
-
* average of _height_ and _width_.
|
|
17604
|
-
* @property {number} [cornerRounding.height=0] The height in pixels.
|
|
17605
|
-
* @property {number} [cornerRounding.width=0] The width in pixels.
|
|
17606
|
-
*
|
|
17607
|
-
* @property {any} [customContext=""] - _Updatable. Inheritable._
|
|
17608
|
-
* A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
|
|
17609
|
-
* is called. If a window in a Platform is trying to update or retrieve its own context, it can use the
|
|
17610
|
-
* {@link Platform#setWindowContext Platform.setWindowContext} and {@link Platform#getWindowContext Platform.getWindowContext} calls.
|
|
17611
|
-
* _When omitted, _inherits_ from the parent application._
|
|
17612
|
-
* As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
|
|
17613
|
-
*
|
|
17614
|
-
* @property {any} [customData=""] - _Updatable. Inheritable._
|
|
17615
|
-
* A field that the user can attach serializable data to be ferried around with the window options.
|
|
17616
|
-
* _When omitted, _inherits_ from the parent application._
|
|
17617
|
-
*
|
|
17618
|
-
* @property {object[]} [customRequestHeaders]
|
|
17619
|
-
* Defines list of custom headers for requests sent by the window.
|
|
17620
|
-
* @property {string[]} [customRequestHeaders.urlPatterns=[]] The URL patterns for which the headers will be applied
|
|
17621
|
-
* @property {object[]} [customRequestHeaders.headers=[]] Objects representing headers and their values,
|
|
17622
|
-
* where the object key is the name of header and value at key is the value of the header
|
|
17623
|
-
*
|
|
17624
|
-
* @property {boolean} [closeOnLastViewRemoved=true] - _Experimental._ _Updatable._
|
|
17625
|
-
* Toggling off would keep the Window alive even if all its Views were closed.
|
|
17626
|
-
* This is meant for advanced users and should be used with caution.
|
|
17627
|
-
* Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
|
|
17628
|
-
* Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
|
|
17629
|
-
* ** note ** - This option is ignored in non-Platforms apps.
|
|
17630
|
-
*
|
|
17631
|
-
* @property {boolean} [defaultCentered=false]
|
|
17632
|
-
* Centers the window in the primary monitor. This option overrides `defaultLeft` and `defaultTop`. When `saveWindowState` is `true`,
|
|
17633
|
-
* this value will be ignored for subsequent launches in favor of the cached value. **NOTE:** On macOS _defaultCenter_ is
|
|
17634
|
-
* somewhat above center vertically.
|
|
17635
|
-
*
|
|
17636
|
-
* @property {number} [defaultHeight=500]
|
|
17637
|
-
* The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
|
|
17638
|
-
* in favor of the cached value.
|
|
17639
|
-
*
|
|
17640
|
-
* @property {number} [defaultLeft=100]
|
|
17641
|
-
* The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
|
17642
|
-
* launches in favor of the cached value.
|
|
17643
|
-
*
|
|
17644
|
-
* @property {number} [defaultTop=100]
|
|
17645
|
-
* The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
|
17646
|
-
* launches in favor of the cached value.
|
|
17647
|
-
*
|
|
17648
|
-
* @property {number} [defaultWidth=800]
|
|
17649
|
-
* The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
|
17650
|
-
* launches in favor of the cached value.
|
|
17651
|
-
*
|
|
17652
|
-
* @property {boolean} [includeInSnapshots=true] - _Updatable._
|
|
17653
|
-
* When true, the window will be be included in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
|
|
17654
|
-
* inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
|
|
17655
|
-
*
|
|
17656
|
-
* @property {boolean} [frame=true] - _Updatable._
|
|
17657
|
-
* A flag to show the frame.
|
|
17658
|
-
*
|
|
17659
|
-
* @hidden-property {boolean} [hideOnClose=false] - A flag to allow a window to be hidden when the close button is clicked.
|
|
17660
|
-
*
|
|
17661
|
-
* @property {object[]} [hotkeys=[]] - _Updatable._
|
|
17662
|
-
* Defines the list of hotkeys that will be emitted as a `hotkey` event on the window. For usage example see [example]{@tutorial hotkeys}.
|
|
17663
|
-
* Within Platform, OpenFin also implements a set of pre-defined actions called
|
|
17664
|
-
* [keyboard commands]{@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands}
|
|
17665
|
-
* that can be assigned to a specific hotkey in the platform manifest.
|
|
17666
|
-
* @property {string} hotkeys.keys The key combination of the hotkey, i.e. "Ctrl+T"
|
|
17667
|
-
* @property {boolean} [hotkeys.preventDefault=false] Whether or not to prevent default key handling before emitting the event
|
|
17668
|
-
*
|
|
17669
|
-
* @property {string} [icon] - _Updatable. Inheritable._
|
|
17670
|
-
* A URL for the icon to be shown in the window title bar and the taskbar.
|
|
17671
|
-
* When omitted, inherits from the parent application._
|
|
17672
|
-
* note: Window OS caches taskbar icons, therefore an icon change might only be visible after the cache is removed or the uuid is changed.
|
|
17673
|
-
*
|
|
17674
|
-
* @property {number} [maxHeight=-1] - _Updatable._
|
|
17675
|
-
* The maximum height of a window. Will default to the OS defined value if set to -1.
|
|
17676
|
-
*
|
|
17677
|
-
* @property {boolean} [maximizable=true] - _Updatable._
|
|
17678
|
-
* A flag that lets the window be maximized.
|
|
17679
|
-
*
|
|
17680
|
-
* @property {number} [maxWidth=-1] - _Updatable._
|
|
17681
|
-
* The maximum width of a window. Will default to the OS defined value if set to -1.
|
|
17682
|
-
*
|
|
17683
|
-
* @property {number} [minHeight=0] - _Updatable._
|
|
17684
|
-
* The minimum height of a window.
|
|
17685
|
-
*
|
|
17686
|
-
* @property {boolean} [minimizable=true] - _Updatable._
|
|
17687
|
-
* A flag that lets the window be minimized.
|
|
17688
|
-
*
|
|
17689
|
-
* @property {number} [minWidth=0] - _Updatable._
|
|
17690
|
-
* The minimum width of a window.
|
|
17691
|
-
*
|
|
17692
|
-
* @property {Identity} [modalParentIdentity]
|
|
17693
|
-
* Parent identity of a modal window. It will create a modal child window when this option is set.
|
|
17694
|
-
*
|
|
17695
|
-
* @property {string} name
|
|
17696
|
-
* The name of the window.
|
|
17697
|
-
*
|
|
17698
|
-
* @property {number} [opacity=1.0] - _Updatable._
|
|
17699
|
-
* A flag that specifies how transparent the window will be.
|
|
17700
|
-
* Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
|
|
17701
|
-
* This value is clamped between `0.0` and `1.0`.
|
|
17702
|
-
* * In software composition mode, the runtime flag --allow-unsafe-compositing is required.
|
|
17703
|
-
*
|
|
17704
|
-
* @property {preloadScript[]} [preloadScripts] - _Inheritable_
|
|
17705
|
-
* A list of scripts that are eval'ed before other scripts in the page. When omitted, _inherits_
|
|
17706
|
-
* from the parent application.
|
|
17707
|
-
*
|
|
17708
|
-
* @property {string} [processAffinity]
|
|
17709
|
-
* A string to attempt to group renderers together. Will only be used if pages are on the same origin.
|
|
17710
|
-
*
|
|
17711
|
-
* @property {boolean} [resizable=true] - _Updatable._
|
|
17712
|
-
* A flag to allow the user to resize the window.
|
|
17713
|
-
*
|
|
17714
|
-
* @property {object} [resizeRegion] - _Updatable._
|
|
17715
|
-
* Defines a region in pixels that will respond to user mouse interaction for resizing a frameless window.
|
|
17716
|
-
* @property {number} [resizeRegion.bottomRightCorner=9]
|
|
17717
|
-
* The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
|
|
17718
|
-
* @property {number} [resizeRegion.size=7]
|
|
17719
|
-
* The size in pixels.
|
|
17720
|
-
* @property {object} [resizeRegion.sides={top:true,right:true,bottom:true,left:true}]
|
|
17721
|
-
* Sides that a window can be resized from.
|
|
17722
|
-
*
|
|
17723
|
-
* @property {boolean} [saveWindowState=true]
|
|
17724
|
-
* A flag to cache the location of the window.
|
|
17725
|
-
* ** note ** - This option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
|
|
17726
|
-
*
|
|
17727
|
-
* @property {boolean} [ignoreSavedWindowState]
|
|
17728
|
-
* A flag to ignore previously cached state of the window. It defaults the opposite value of `saveWindowState` to maintain backwards compatibility.
|
|
17729
|
-
*
|
|
17730
|
-
* @property {boolean} [shadow=false]
|
|
17731
|
-
* A flag to display a shadow on frameless windows.
|
|
17732
|
-
* `shadow` and `cornerRounding` are mutually exclusive.
|
|
17733
|
-
* On Windows 7, Aero theme is required.
|
|
17734
|
-
*
|
|
17735
|
-
* @property {boolean} [showBackgroundImages=false] - _Updatable._
|
|
17736
|
-
* Platforms Only. If true, will show background images in the layout when the Views are hidden.
|
|
17737
|
-
* This occurs when the window is resizing or a tab is being dragged within the layout.
|
|
17738
|
-
*
|
|
17739
|
-
* @property {boolean} [showTaskbarIcon=true] - _Updatable._ _Windows_.
|
|
17740
|
-
* A flag to show the window's icon in the taskbar.
|
|
17741
|
-
*
|
|
17742
|
-
* @property {boolean} [smallWindow=false]
|
|
17743
|
-
* A flag to specify a frameless window that can be be created and resized to less than 41x36 px (width x height).
|
|
17744
|
-
* _Note: Caveats of small windows are no Aero Snap and drag to/from maximize._
|
|
17745
|
-
* _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
|
|
17746
|
-
*
|
|
17747
|
-
* @property {boolean} [spellCheck=false]
|
|
17748
|
-
* Enable spell check in input text fields for the window.
|
|
17749
|
-
*
|
|
17750
|
-
* @property {string} [state="normal"]
|
|
17751
|
-
* The visible state of the window on creation.
|
|
17752
|
-
* One of:
|
|
17753
|
-
* * `"maximized"`
|
|
17754
|
-
* * `"minimized"`
|
|
17755
|
-
* * `"normal"`
|
|
17756
|
-
*
|
|
17757
|
-
* @property {string} [taskbarIcon=string] - Deprecated - use `icon` instead._Windows_.
|
|
17758
|
-
*
|
|
17759
|
-
* @property {string} [taskbarIconGroup=<application uuid>] - _Windows_.
|
|
17760
|
-
* Specify a taskbar group for the window.
|
|
17761
|
-
* _If omitted, defaults to app's uuid (`fin.Application.getCurrentSync().identity.uuid`)._
|
|
17762
|
-
*
|
|
17763
|
-
* @property {string} [url="about:blank"]
|
|
17764
|
-
* The URL of the window.
|
|
17765
|
-
*
|
|
17766
|
-
* @property {string} [uuid=<application uuid>]
|
|
17767
|
-
* The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
|
|
17768
|
-
* If omitted, defaults to the `uuid` of the application spawning the window.
|
|
17769
|
-
* If given, must match the `uuid` of the application spawning the window.
|
|
17770
|
-
* In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
|
|
17771
|
-
* really no need to provide it.
|
|
17772
|
-
*
|
|
17773
|
-
* @property {boolean} [waitForPageLoad=false]
|
|
17774
|
-
* When set to `true`, the window will not appear until the `window` object's `load` event fires.
|
|
17775
|
-
* When set to `false`, the window will appear immediately without waiting for content to be loaded.
|
|
17776
|
-
*
|
|
17777
|
-
* @property {ViewVisibility} [viewVisibility]
|
|
17778
|
-
* _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
|
|
17779
|
-
*/
|
|
17780
|
-
/**
|
|
17781
|
-
* @PORTED
|
|
17782
|
-
* @typedef {Object} ViewVisibility@typedef {Object} ViewVisibility _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
|
|
17783
|
-
* @property {ShowViewsOnWindowResize} [showViewsOnWindowResize] Enables views to be shown when a Platform Window is being resized by the user.
|
|
17784
|
-
* @property {ShowViewsOnSplitterDrag} [showViewsOnSplitterDrag] Allows views to be shown when they are resized by the user dragging the splitter between layout stacks.
|
|
17785
|
-
* @property {ShowViewsOnTabDrag} [showViewsOnTabDrag] _Supported on Windows Operating Systems only_. Allows views to be shown when the user is dragging a tab around a layout.
|
|
17786
|
-
*/
|
|
17787
|
-
/**
|
|
17788
|
-
* @PORTED
|
|
17789
|
-
* @typedef {Object} ShowViewsOnWindowResize@typedef {Object} ShowViewsOnWindowResize _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
|
|
17790
|
-
* @property {boolean} [enabled=false] Enables or disables showing Views when a Platform Window is being resized.
|
|
17791
|
-
* @property {number} [paintIntervalMs=0] Number of miliseconds to wait between view repaints.
|
|
17792
|
-
*/
|
|
17793
|
-
/**
|
|
17794
|
-
* @REMOVED
|
|
17795
|
-
* @typedef {Object} ShowViewsOnSplitterDrag@typedef {Object} ShowViewsOnSplitterDrag _Platform Windows Only_. Allows views to be shown when they are resized by the user dragging the splitter between layout stacks.
|
|
17796
|
-
* @property {boolean} [enabled=false] Enables or disables showing views when the layout splitter is being dragged.
|
|
17797
|
-
*/
|
|
17798
|
-
/**
|
|
17799
|
-
* @REMOVED
|
|
17800
|
-
* @typedef {Object} ShowViewsOnTabDrag@typedef {Object} ShowViewsOnTabDrag _Platform Windows Only_. Allows views to be shown when the user is manipulating the layout by repositioning a tab.
|
|
17801
|
-
* @property {boolean} [enabled=false] Enables or disables showing views when a tab is being dragged.
|
|
17802
|
-
*/
|
|
17803
|
-
/**
|
|
17804
|
-
* @PORTED
|
|
17805
|
-
* @typedef {object} CapturePageOptions@typedef {object} CapturePageOptions
|
|
17806
|
-
* @property { Area } [area] The area of the window to be captured.
|
|
17807
|
-
* @property { string } [format='png'] The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
|
|
17808
|
-
* @property { number } [quality=100] Number representing quality of JPEG image only. Between 0 - 100.
|
|
17809
|
-
*/
|
|
17810
|
-
/**
|
|
17811
|
-
* @PORTED
|
|
17812
|
-
* @typedef { object } Area@typedef { object } Area
|
|
17813
|
-
* @property { number } height Area's height
|
|
17814
|
-
* @property { number } width Area's width
|
|
17815
|
-
* @property { number } x X coordinate of area's starting point
|
|
17816
|
-
* @property { number } y Y coordinate of area's starting point
|
|
17817
|
-
*/
|
|
17818
|
-
/**
|
|
17819
|
-
* @PORTED
|
|
17820
|
-
* @typedef {object} FindInPageOptions@typedef {object} FindInPageOptions
|
|
17821
|
-
* @property {boolean} [forward=true] Whether to search forward or backward.
|
|
17822
|
-
* @property {boolean} [findNext=false] Whether to begin a new text finding session. Should be true for first requests, and false for subsequent requests. Defaults to false.
|
|
17823
|
-
* @property {boolean} [matchCase=false] Whether search should be case-sensitive.
|
|
17824
|
-
* @property {boolean} [wordStart=false] Whether to look only at the start of words.
|
|
17825
|
-
* @property {boolean} [medialCapitalAsWordStart=false]
|
|
17826
|
-
* When combined with wordStart, accepts a match in the middle of a word if the match begins with an uppercase letter followed by a<br>
|
|
17827
|
-
* lowercase or non-letter. Accepts several other intra-word matches.
|
|
17828
|
-
*/
|
|
17829
|
-
/**
|
|
17830
|
-
* @REMOVED
|
|
17831
|
-
* @typedef {object} Transition@typedef {object} Transition
|
|
17832
|
-
* @property {Opacity} opacity - The Opacity transition
|
|
17833
|
-
* @property {Position} position - The Position transition
|
|
17834
|
-
* @property {Size} size - The Size transition
|
|
17835
|
-
*/
|
|
17836
|
-
/**
|
|
17837
|
-
* @PORTED
|
|
17838
|
-
* @typedef {object} TransitionOptions@typedef {object} TransitionOptions
|
|
17839
|
-
* @property {boolean} interrupt - This option interrupts the current animation. When false it pushes
|
|
17840
|
-
this animation onto the end of the animation queue.
|
|
17841
|
-
* @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
|
|
17842
|
-
*/
|
|
17843
|
-
/**
|
|
17844
|
-
* @PORTED
|
|
17845
|
-
* @typedef {object} Size@typedef {object} Size
|
|
17846
|
-
* @property {number} duration - The total time in milliseconds this transition should take.
|
|
17847
|
-
* @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
|
|
17848
|
-
* @property {number} width - Optional if height is present. Defaults to the window's current width.
|
|
17849
|
-
* @property {number} height - Optional if width is present. Defaults to the window's current height.
|
|
17850
|
-
*/
|
|
17851
|
-
/**
|
|
17852
|
-
* @PORTED
|
|
17853
|
-
* @typedef {object} Position@typedef {object} Position
|
|
17854
|
-
* @property {number} duration - The total time in milliseconds this transition should take.
|
|
17855
|
-
* @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
|
|
17856
|
-
* @property {number} left - Defaults to the window's current left position in virtual screen coordinates.
|
|
17857
|
-
* @property {number} top - Defaults to the window's current top position in virtual screen coordinates.
|
|
17858
|
-
*/
|
|
17859
|
-
/**
|
|
17860
|
-
* @PORTED
|
|
17861
|
-
* @typedef {object} Opacity@typedef {object} Opacity
|
|
17862
|
-
* @property {number} duration - The total time in milliseconds this transition should take.
|
|
17863
|
-
* @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
|
|
17864
|
-
* @property {number} opacity - This value is clamped from 0.0 to 1.0.
|
|
17865
|
-
*/
|
|
17866
|
-
/**
|
|
17867
|
-
* @REMOVED
|
|
17868
|
-
* Bounds is a interface that has the properties of height,
|
|
17869
|
-
* width, left, top which are all numbers
|
|
17870
|
-
* @typedef { object } Bounds@typedef { object } Bounds
|
|
17871
|
-
* @property { number } height Get the application height bound
|
|
17872
|
-
* @property { number } width Get the application width bound
|
|
17873
|
-
* @property { number } top Get the application top bound
|
|
17874
|
-
* @property { number } left Get the application left bound
|
|
17875
|
-
* @property { number } right Get the application right bound
|
|
17876
|
-
* @property { number } bottom Get the application bottom bound
|
|
17877
|
-
*/
|
|
17878
17166
|
/**
|
|
17879
17167
|
* A basic window that wraps a native HTML window. Provides more fine-grained
|
|
17880
17168
|
* control over the window state such as the ability to minimize, maximize, restore, etc.
|
|
@@ -18660,10 +17948,9 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
18660
17948
|
show(force?: boolean): Promise<void>;
|
|
18661
17949
|
/**
|
|
18662
17950
|
* Shows the window if it is hidden at the specified location.
|
|
18663
|
-
*
|
|
18664
|
-
*
|
|
18665
|
-
* @param
|
|
18666
|
-
* @param top The right position of the window
|
|
17951
|
+
*
|
|
17952
|
+
* @param left The left position of the window in pixels
|
|
17953
|
+
* @param top The top position of the window in pixels
|
|
18667
17954
|
* @param force Show will be prevented from closing when force is false and
|
|
18668
17955
|
* ‘show-requested’ has been subscribed to for application’s main window
|
|
18669
17956
|
*
|
|
@@ -18725,28 +18012,6 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
18725
18012
|
* ```
|
|
18726
18013
|
*/
|
|
18727
18014
|
authenticate(userName: string, password: string): Promise<void>;
|
|
18728
|
-
/**
|
|
18729
|
-
* @typedef {object} ShowPopupMenuOptions@typedef {object} ShowPopupMenuOptions
|
|
18730
|
-
* @property {Array<MenuItemTemplate>} template - An array describing the menu to show.
|
|
18731
|
-
* @property {number} [x] - The window x coordinate where to show the menu. Defaults to mouse position. If using must also use `y`.
|
|
18732
|
-
* @property {number} [y] - The window y coordinate where to show the menu. Defaults to mouse position. If using must also use `x`
|
|
18733
|
-
*/
|
|
18734
|
-
/**
|
|
18735
|
-
* @typedef {object} MenuItemTemplate@typedef {object} MenuItemTemplate
|
|
18736
|
-
* @property {*} data - Data to be returned if the user selects the element. Must be serializable. Large objects can have a performance impact.
|
|
18737
|
-
* @property {'normal' | 'separator' | 'submenu' | 'checkbox'} [type] - Defaults to 'normal' unless a 'submenu' key exists
|
|
18738
|
-
* @property {string} [label] - The text to show on the menu item. Should be left undefined for `type: 'separator'`
|
|
18739
|
-
* @property {boolean} [enabled] - If false, the menu item will be greyed out and unclickable.
|
|
18740
|
-
* @property {boolean} [visible] - If false, the menu item will be entirely hidden.
|
|
18741
|
-
* @property {boolean} [checked] - Should only be specified for `checkbox` type menu items.
|
|
18742
|
-
* @property {string} [icon] - Image Data URI with image dimensions inferred from the encoded string
|
|
18743
|
-
* @property {Array<MenuItemTemplate>} [submenu] Should be specified for `submenu` type menu items. If `submenu` is specified, the `type: 'submenu'` can be omitted.
|
|
18744
|
-
*/
|
|
18745
|
-
/**
|
|
18746
|
-
* @typedef {object} MenuResult@typedef {object} MenuResult
|
|
18747
|
-
* @property {'clicked' | 'closed'} result - Whether the user clicked on a menu item or the menu was closed (user clicked elsewhere).
|
|
18748
|
-
* @property {* | undefined} [data] - The data property of the menu item clicked by the user. Only defined if result was `clicked`.
|
|
18749
|
-
*/
|
|
18750
18015
|
/**
|
|
18751
18016
|
* Shows a menu on the window.
|
|
18752
18017
|
*
|
|
@@ -18843,602 +18108,552 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
18843
18108
|
*/
|
|
18844
18109
|
closePopupMenu(): Promise<void>;
|
|
18845
18110
|
/**
|
|
18846
|
-
*
|
|
18847
|
-
*
|
|
18848
|
-
* @
|
|
18849
|
-
* @
|
|
18850
|
-
*
|
|
18851
|
-
|
|
18852
|
-
|
|
18853
|
-
|
|
18854
|
-
|
|
18855
|
-
|
|
18856
|
-
|
|
18857
|
-
|
|
18858
|
-
|
|
18859
|
-
|
|
18860
|
-
|
|
18861
|
-
|
|
18862
|
-
|
|
18863
|
-
|
|
18864
|
-
|
|
18865
|
-
|
|
18866
|
-
|
|
18867
|
-
|
|
18868
|
-
|
|
18869
|
-
|
|
18870
|
-
|
|
18871
|
-
|
|
18872
|
-
|
|
18873
|
-
|
|
18874
|
-
|
|
18875
|
-
|
|
18876
|
-
|
|
18877
|
-
|
|
18878
|
-
|
|
18879
|
-
|
|
18880
|
-
|
|
18881
|
-
|
|
18882
|
-
|
|
18883
|
-
|
|
18884
|
-
|
|
18885
|
-
|
|
18886
|
-
|
|
18887
|
-
|
|
18888
|
-
|
|
18889
|
-
|
|
18890
|
-
|
|
18891
|
-
|
|
18892
|
-
|
|
18893
|
-
|
|
18894
|
-
|
|
18895
|
-
|
|
18896
|
-
|
|
18897
|
-
|
|
18898
|
-
|
|
18899
|
-
|
|
18900
|
-
|
|
18901
|
-
|
|
18902
|
-
|
|
18903
|
-
|
|
18904
|
-
|
|
18905
|
-
|
|
18906
|
-
|
|
18907
|
-
|
|
18908
|
-
|
|
18909
|
-
|
|
18910
|
-
|
|
18911
|
-
|
|
18912
|
-
|
|
18913
|
-
|
|
18914
|
-
|
|
18915
|
-
|
|
18916
|
-
|
|
18917
|
-
|
|
18918
|
-
|
|
18919
|
-
|
|
18920
|
-
|
|
18921
|
-
|
|
18922
|
-
|
|
18923
|
-
|
|
18924
|
-
|
|
18925
|
-
|
|
18926
|
-
|
|
18927
|
-
|
|
18928
|
-
|
|
18929
|
-
|
|
18930
|
-
|
|
18931
|
-
|
|
18932
|
-
|
|
18933
|
-
|
|
18934
|
-
|
|
18935
|
-
|
|
18936
|
-
|
|
18937
|
-
|
|
18938
|
-
|
|
18939
|
-
|
|
18940
|
-
|
|
18941
|
-
|
|
18942
|
-
|
|
18943
|
-
|
|
18944
|
-
|
|
18945
|
-
|
|
18946
|
-
|
|
18947
|
-
|
|
18948
|
-
|
|
18949
|
-
|
|
18950
|
-
|
|
18951
|
-
|
|
18952
|
-
|
|
18953
|
-
|
|
18954
|
-
|
|
18955
|
-
|
|
18956
|
-
|
|
18957
|
-
|
|
18958
|
-
|
|
18959
|
-
|
|
18960
|
-
|
|
18961
|
-
|
|
18962
|
-
|
|
18963
|
-
|
|
18964
|
-
|
|
18965
|
-
|
|
18966
|
-
|
|
18967
|
-
|
|
18968
|
-
|
|
18969
|
-
|
|
18970
|
-
|
|
18971
|
-
|
|
18972
|
-
|
|
18973
|
-
|
|
18974
|
-
|
|
18975
|
-
|
|
18976
|
-
|
|
18977
|
-
|
|
18978
|
-
|
|
18979
|
-
|
|
18980
|
-
|
|
18981
|
-
|
|
18982
|
-
|
|
18983
|
-
|
|
18984
|
-
|
|
18985
|
-
|
|
18986
|
-
|
|
18987
|
-
|
|
18988
|
-
|
|
18989
|
-
|
|
18990
|
-
|
|
18991
|
-
|
|
18992
|
-
|
|
18993
|
-
|
|
18994
|
-
|
|
18995
|
-
|
|
18996
|
-
|
|
18997
|
-
|
|
18998
|
-
|
|
18999
|
-
|
|
19000
|
-
|
|
19001
|
-
|
|
19002
|
-
|
|
19003
|
-
|
|
19004
|
-
|
|
19005
|
-
|
|
19006
|
-
|
|
19007
|
-
|
|
19008
|
-
|
|
19009
|
-
|
|
19010
|
-
|
|
19011
|
-
|
|
19012
|
-
|
|
19013
|
-
|
|
19014
|
-
|
|
19015
|
-
|
|
19016
|
-
|
|
19017
|
-
|
|
19018
|
-
|
|
19019
|
-
|
|
19020
|
-
|
|
19021
|
-
|
|
19022
|
-
|
|
19023
|
-
|
|
19024
|
-
|
|
19025
|
-
|
|
19026
|
-
|
|
19027
|
-
|
|
19028
|
-
|
|
19029
|
-
|
|
19030
|
-
|
|
19031
|
-
|
|
19032
|
-
|
|
19033
|
-
|
|
19034
|
-
|
|
19035
|
-
|
|
19036
|
-
|
|
19037
|
-
|
|
19038
|
-
|
|
19039
|
-
|
|
19040
|
-
|
|
19041
|
-
|
|
19042
|
-
|
|
19043
|
-
|
|
19044
|
-
|
|
19045
|
-
|
|
19046
|
-
|
|
19047
|
-
|
|
19048
|
-
|
|
19049
|
-
|
|
19050
|
-
|
|
19051
|
-
|
|
19052
|
-
|
|
19053
|
-
|
|
19054
|
-
|
|
19055
|
-
|
|
19056
|
-
|
|
19057
|
-
|
|
19058
|
-
|
|
19059
|
-
|
|
19060
|
-
|
|
19061
|
-
|
|
19062
|
-
|
|
19063
|
-
|
|
19064
|
-
|
|
19065
|
-
|
|
19066
|
-
|
|
19067
|
-
|
|
19068
|
-
|
|
19069
|
-
|
|
19070
|
-
|
|
19071
|
-
|
|
19072
|
-
|
|
19073
|
-
|
|
19074
|
-
|
|
19075
|
-
|
|
19076
|
-
|
|
19077
|
-
|
|
19078
|
-
|
|
19079
|
-
|
|
19080
|
-
|
|
19081
|
-
|
|
19082
|
-
|
|
19083
|
-
|
|
19084
|
-
|
|
19085
|
-
|
|
19086
|
-
|
|
19087
|
-
|
|
19088
|
-
|
|
19089
|
-
|
|
19090
|
-
|
|
19091
|
-
|
|
19092
|
-
|
|
19093
|
-
|
|
19094
|
-
|
|
19095
|
-
|
|
19096
|
-
|
|
19097
|
-
|
|
19098
|
-
|
|
19099
|
-
|
|
19100
|
-
|
|
19101
|
-
|
|
19102
|
-
|
|
19103
|
-
|
|
19104
|
-
|
|
19105
|
-
|
|
19106
|
-
|
|
19107
|
-
|
|
19108
|
-
|
|
19109
|
-
|
|
19110
|
-
|
|
19111
|
-
|
|
19112
|
-
|
|
19113
|
-
|
|
19114
|
-
|
|
19115
|
-
|
|
19116
|
-
|
|
19117
|
-
|
|
19118
|
-
|
|
19119
|
-
|
|
19120
|
-
|
|
19121
|
-
|
|
19122
|
-
|
|
19123
|
-
|
|
19124
|
-
|
|
19125
|
-
|
|
19126
|
-
|
|
19127
|
-
|
|
19128
|
-
|
|
19129
|
-
|
|
19130
|
-
|
|
19131
|
-
|
|
19132
|
-
|
|
19133
|
-
|
|
19134
|
-
|
|
19135
|
-
|
|
19136
|
-
|
|
19137
|
-
|
|
19138
|
-
|
|
19139
|
-
|
|
19140
|
-
|
|
19141
|
-
|
|
19142
|
-
|
|
19143
|
-
|
|
19144
|
-
|
|
19145
|
-
|
|
19146
|
-
|
|
19147
|
-
|
|
19148
|
-
|
|
19149
|
-
|
|
19150
|
-
|
|
19151
|
-
|
|
19152
|
-
|
|
19153
|
-
|
|
19154
|
-
|
|
19155
|
-
|
|
19156
|
-
|
|
19157
|
-
|
|
19158
|
-
|
|
19159
|
-
|
|
19160
|
-
|
|
19161
|
-
|
|
19162
|
-
|
|
19163
|
-
|
|
19164
|
-
|
|
19165
|
-
|
|
19166
|
-
|
|
19167
|
-
|
|
19168
|
-
|
|
19169
|
-
|
|
19170
|
-
|
|
19171
|
-
|
|
19172
|
-
|
|
19173
|
-
|
|
19174
|
-
|
|
19175
|
-
|
|
19176
|
-
|
|
19177
|
-
|
|
19178
|
-
|
|
19179
|
-
|
|
19180
|
-
|
|
19181
|
-
|
|
19182
|
-
|
|
19183
|
-
|
|
19184
|
-
|
|
19185
|
-
|
|
19186
|
-
|
|
19187
|
-
|
|
19188
|
-
|
|
19189
|
-
|
|
19190
|
-
|
|
19191
|
-
|
|
19192
|
-
|
|
19193
|
-
|
|
19194
|
-
|
|
19195
|
-
|
|
19196
|
-
|
|
19197
|
-
|
|
19198
|
-
|
|
19199
|
-
|
|
19200
|
-
|
|
19201
|
-
|
|
19202
|
-
|
|
19203
|
-
|
|
19204
|
-
|
|
19205
|
-
|
|
19206
|
-
|
|
19207
|
-
|
|
19208
|
-
|
|
19209
|
-
|
|
19210
|
-
|
|
19211
|
-
|
|
19212
|
-
|
|
19213
|
-
|
|
19214
|
-
|
|
19215
|
-
|
|
19216
|
-
|
|
19217
|
-
|
|
19218
|
-
|
|
19219
|
-
|
|
19220
|
-
|
|
19221
|
-
|
|
19222
|
-
|
|
19223
|
-
|
|
19224
|
-
|
|
19225
|
-
|
|
19226
|
-
|
|
19227
|
-
|
|
19228
|
-
|
|
19229
|
-
|
|
19230
|
-
|
|
19231
|
-
|
|
19232
|
-
|
|
19233
|
-
|
|
19234
|
-
|
|
19235
|
-
|
|
19236
|
-
|
|
19237
|
-
|
|
19238
|
-
|
|
19239
|
-
|
|
19240
|
-
|
|
19241
|
-
|
|
19242
|
-
|
|
19243
|
-
|
|
19244
|
-
|
|
19245
|
-
|
|
19246
|
-
|
|
19247
|
-
|
|
19248
|
-
|
|
19249
|
-
|
|
19250
|
-
|
|
19251
|
-
|
|
19252
|
-
|
|
19253
|
-
|
|
19254
|
-
|
|
19255
|
-
|
|
19256
|
-
|
|
19257
|
-
|
|
19258
|
-
|
|
19259
|
-
|
|
19260
|
-
|
|
19261
|
-
|
|
19262
|
-
|
|
19263
|
-
|
|
19264
|
-
|
|
19265
|
-
|
|
19266
|
-
|
|
19267
|
-
|
|
19268
|
-
|
|
19269
|
-
|
|
19270
|
-
|
|
19271
|
-
|
|
19272
|
-
|
|
19273
|
-
|
|
19274
|
-
|
|
19275
|
-
|
|
19276
|
-
|
|
19277
|
-
|
|
19278
|
-
|
|
19279
|
-
|
|
19280
|
-
|
|
19281
|
-
|
|
19282
|
-
|
|
19283
|
-
|
|
19284
|
-
|
|
19285
|
-
|
|
19286
|
-
|
|
19287
|
-
|
|
19288
|
-
|
|
19289
|
-
|
|
19290
|
-
|
|
19291
|
-
|
|
19292
|
-
|
|
19293
|
-
|
|
19294
|
-
|
|
19295
|
-
|
|
19296
|
-
|
|
19297
|
-
|
|
19298
|
-
|
|
19299
|
-
|
|
19300
|
-
|
|
19301
|
-
|
|
19302
|
-
|
|
19303
|
-
|
|
19304
|
-
|
|
19305
|
-
|
|
19306
|
-
|
|
19307
|
-
|
|
19308
|
-
|
|
19309
|
-
|
|
19310
|
-
|
|
19311
|
-
|
|
19312
|
-
|
|
19313
|
-
|
|
19314
|
-
|
|
19315
|
-
|
|
19316
|
-
|
|
19317
|
-
|
|
19318
|
-
|
|
19319
|
-
|
|
19320
|
-
|
|
19321
|
-
|
|
19322
|
-
|
|
19323
|
-
|
|
19324
|
-
|
|
19325
|
-
|
|
19326
|
-
|
|
19327
|
-
|
|
19328
|
-
|
|
19329
|
-
|
|
19330
|
-
|
|
19331
|
-
|
|
19332
|
-
|
|
19333
|
-
|
|
19334
|
-
|
|
19335
|
-
|
|
19336
|
-
|
|
19337
|
-
|
|
19338
|
-
|
|
19339
|
-
|
|
19340
|
-
|
|
19341
|
-
|
|
19342
|
-
|
|
19343
|
-
|
|
19344
|
-
|
|
19345
|
-
|
|
19346
|
-
|
|
19347
|
-
|
|
19348
|
-
|
|
19349
|
-
|
|
19350
|
-
|
|
19351
|
-
|
|
19352
|
-
|
|
19353
|
-
|
|
19354
|
-
|
|
19355
|
-
|
|
19356
|
-
|
|
19357
|
-
|
|
19358
|
-
|
|
19359
|
-
|
|
19360
|
-
|
|
19361
|
-
|
|
19362
|
-
|
|
19363
|
-
|
|
19364
|
-
|
|
19365
|
-
|
|
19366
|
-
|
|
19367
|
-
|
|
19368
|
-
|
|
19369
|
-
|
|
19370
|
-
|
|
19371
|
-
|
|
19372
|
-
|
|
19373
|
-
|
|
19374
|
-
|
|
19375
|
-
|
|
19376
|
-
|
|
19377
|
-
|
|
19378
|
-
|
|
19379
|
-
|
|
19380
|
-
|
|
19381
|
-
|
|
19382
|
-
|
|
19383
|
-
|
|
19384
|
-
|
|
19385
|
-
|
|
19386
|
-
|
|
19387
|
-
|
|
19388
|
-
|
|
19389
|
-
|
|
19390
|
-
|
|
19391
|
-
|
|
19392
|
-
|
|
19393
|
-
|
|
19394
|
-
|
|
19395
|
-
*/
|
|
19396
|
-
data: {
|
|
19397
|
-
text?: string;
|
|
19398
|
-
html?: string;
|
|
19399
|
-
rtf?: string;
|
|
19400
|
-
} & Partial<Pick<WriteImageClipboardRequest, 'image'>>;
|
|
19401
|
-
};
|
|
19402
|
-
|
|
19403
|
-
/**
|
|
19404
|
-
* @deprecated - instead use WriteAnyClipboardRequest
|
|
19405
|
-
*
|
|
19406
|
-
* A generic request to write any supported data to the clipboard.
|
|
19407
|
-
*
|
|
19408
|
-
* @interface
|
|
19409
|
-
*/
|
|
19410
|
-
declare type WriteAnyRequestType = WriteAnyClipboardRequest;
|
|
19411
|
-
|
|
19412
|
-
/**
|
|
19413
|
-
* A request to write data to the clipboard.
|
|
19414
|
-
* @interface
|
|
19415
|
-
*/
|
|
19416
|
-
declare type WriteClipboardRequest = BaseClipboardRequest & {
|
|
19417
|
-
/**
|
|
19418
|
-
* Data to write to the clipboard.
|
|
19419
|
-
*/
|
|
19420
|
-
data: string;
|
|
19421
|
-
};
|
|
19422
|
-
|
|
19423
|
-
/**
|
|
19424
|
-
* @interface
|
|
19425
|
-
*/
|
|
19426
|
-
declare type WriteImageClipboardRequest = BaseClipboardRequest & {
|
|
19427
|
-
/**
|
|
19428
|
-
* Can be either a base64 string, or a DataURL string. If using DataURL, the
|
|
19429
|
-
* supported formats are `data:image/png[;base64],` and `data:image/jpeg[;base64],`.
|
|
19430
|
-
* Using other image/<format> DataURLs will throw an Error.
|
|
19431
|
-
*/
|
|
19432
|
-
image: string;
|
|
19433
|
-
};
|
|
19434
|
-
|
|
19435
|
-
/**
|
|
19436
|
-
* @deprecated - instead use OpenFin.WriteClipboardRequest
|
|
19437
|
-
*
|
|
19438
|
-
* A request to write data to the clipboard.
|
|
19439
|
-
*
|
|
19440
|
-
* @interface
|
|
19441
|
-
*/
|
|
19442
|
-
declare type WriteRequestType = WriteClipboardRequest;
|
|
19443
|
-
|
|
19444
|
-
export { }
|
|
18111
|
+
* Dispatch a result to the caller of `showPopupWindow`.
|
|
18112
|
+
*
|
|
18113
|
+
* @remarks If this window isn't currently being shown as a popup, this call will silently fail.
|
|
18114
|
+
* @param data Serializable data to send to the caller window.
|
|
18115
|
+
*
|
|
18116
|
+
* @example
|
|
18117
|
+
* ```js
|
|
18118
|
+
* await fin.me.dispatchPopupResult({
|
|
18119
|
+
* foo: 'bar'
|
|
18120
|
+
* });
|
|
18121
|
+
* ```
|
|
18122
|
+
*/
|
|
18123
|
+
dispatchPopupResult(data: any): Promise<void>;
|
|
18124
|
+
/**
|
|
18125
|
+
* Prints the contents of the window.
|
|
18126
|
+
*
|
|
18127
|
+
* @param options Configuration for the print task.
|
|
18128
|
+
* @remarks When `silent` is set to `true`, the API will pick the system's default printer if deviceName is empty
|
|
18129
|
+
* and the default settings for printing.
|
|
18130
|
+
*
|
|
18131
|
+
* Use the CSS style `page-break-before: always;` to force print to a new page.
|
|
18132
|
+
*
|
|
18133
|
+
* @example
|
|
18134
|
+
* ```js
|
|
18135
|
+
* const win = fin.Window.getCurrentSync();
|
|
18136
|
+
*
|
|
18137
|
+
* win.print({ silent: false, deviceName: 'system-printer-name' }).then(() => {
|
|
18138
|
+
* console.log('print call has been sent to the system');
|
|
18139
|
+
* });
|
|
18140
|
+
* ```
|
|
18141
|
+
*
|
|
18142
|
+
* If a window has embedded views, those views will not print by default. To print a window's contents including embedded views,
|
|
18143
|
+
* use the `content` option:
|
|
18144
|
+
*
|
|
18145
|
+
* ```js
|
|
18146
|
+
* const win = fin.Window.getCurrentSync();
|
|
18147
|
+
*
|
|
18148
|
+
* // Print embedded views
|
|
18149
|
+
* win.print({ content: 'views' });
|
|
18150
|
+
*
|
|
18151
|
+
* // Print screenshot of current window
|
|
18152
|
+
* win.print({ content: 'screenshot' })
|
|
18153
|
+
* ```
|
|
18154
|
+
*
|
|
18155
|
+
* When `content` is set to `views`, the embedded views in the platform window will be concatenated and printed as
|
|
18156
|
+
* individual pages. If `includeSelf` is set to `true`, the platform window itself will be printed as the first
|
|
18157
|
+
* page - be aware that this page will *not* include the embedded views - it will only include the contents of
|
|
18158
|
+
* the platform window itself (e.g. tab stacks), with blank spaces where the view contents would be embedded.
|
|
18159
|
+
*
|
|
18160
|
+
* Due to a known issue, view contents that are not visible at the time `print` is called will not appear when
|
|
18161
|
+
* printing `contents: views`. This includes views that are obscured behind other active UI elements.
|
|
18162
|
+
*
|
|
18163
|
+
* To print the views embedded in their page context, set `content` to `screenshot`.
|
|
18164
|
+
*/
|
|
18165
|
+
print(options?: OpenFin_2.WindowPrintOptions): Promise<void>;
|
|
18166
|
+
}
|
|
18167
|
+
|
|
18168
|
+
/**
|
|
18169
|
+
* Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
|
|
18170
|
+
* @interface
|
|
18171
|
+
*/
|
|
18172
|
+
declare type WindowAlertRequestedEvent = BaseEvent_3 & {
|
|
18173
|
+
type: 'window-alert-requested';
|
|
18174
|
+
};
|
|
18175
|
+
|
|
18176
|
+
/**
|
|
18177
|
+
* Returned from getBounds call. bottom and right are never used for setting.
|
|
18178
|
+
* @interface
|
|
18179
|
+
*/
|
|
18180
|
+
declare type WindowBounds = Bounds & {
|
|
18181
|
+
bottom: number;
|
|
18182
|
+
right: number;
|
|
18183
|
+
};
|
|
18184
|
+
|
|
18185
|
+
/**
|
|
18186
|
+
* @deprecated Renamed to {@link ClosedEvent}.
|
|
18187
|
+
*/
|
|
18188
|
+
declare type WindowClosedEvent = ClosedEvent_2;
|
|
18189
|
+
|
|
18190
|
+
/**
|
|
18191
|
+
* @deprecated Renamed to {@link CloseRequestedEvent}.
|
|
18192
|
+
*/
|
|
18193
|
+
declare type WindowCloseRequestedEvent = CloseRequestedEvent;
|
|
18194
|
+
|
|
18195
|
+
/**
|
|
18196
|
+
* @deprecated Renamed to {@link ClosingEvent}.
|
|
18197
|
+
*/
|
|
18198
|
+
declare type WindowClosingEvent = ClosingEvent;
|
|
18199
|
+
|
|
18200
|
+
/**
|
|
18201
|
+
* A rule prescribing content creation in a {@link OpenFin.Window}.
|
|
18202
|
+
*
|
|
18203
|
+
* @interface
|
|
18204
|
+
*/
|
|
18205
|
+
declare type WindowContentCreationRule = BaseContentCreationRule & {
|
|
18206
|
+
/**
|
|
18207
|
+
* Behavior to use when opening matched content.
|
|
18208
|
+
*/
|
|
18209
|
+
behavior: 'window';
|
|
18210
|
+
/**
|
|
18211
|
+
* Options for newly-created window.
|
|
18212
|
+
*/
|
|
18213
|
+
options?: Partial<WindowOptions>;
|
|
18214
|
+
};
|
|
18215
|
+
|
|
18216
|
+
/**
|
|
18217
|
+
* Generated when a child window is created.
|
|
18218
|
+
* @interface
|
|
18219
|
+
*/
|
|
18220
|
+
declare type WindowCreatedEvent = BaseEvent_3 & {
|
|
18221
|
+
type: 'window-created';
|
|
18222
|
+
};
|
|
18223
|
+
|
|
18224
|
+
/**
|
|
18225
|
+
* Options required to create a new window with {@link Window._WindowModule.create Window.create}.
|
|
18226
|
+
*
|
|
18227
|
+
* Note that `name` is the only required property — albeit the `url` property is usually provided as well
|
|
18228
|
+
* (defaults to `"about:blank"` when omitted).
|
|
18229
|
+
* @interface
|
|
18230
|
+
*/
|
|
18231
|
+
declare type WindowCreationOptions = Partial<WindowOptions> & {
|
|
18232
|
+
name: string;
|
|
18233
|
+
};
|
|
18234
|
+
|
|
18235
|
+
declare type WindowCreationReason = 'tearout' | 'create-view-without-target' | 'api-call' | 'app-creation' | 'restore' | 'apply-snapshot';
|
|
18236
|
+
|
|
18237
|
+
/**
|
|
18238
|
+
* @interface
|
|
18239
|
+
*/
|
|
18240
|
+
declare type WindowDetail = {
|
|
18241
|
+
/**
|
|
18242
|
+
* The bottom-most coordinate of the window.
|
|
18243
|
+
*/
|
|
18244
|
+
bottom: number;
|
|
18245
|
+
/**
|
|
18246
|
+
* The height of the window.
|
|
18247
|
+
*/
|
|
18248
|
+
height: number;
|
|
18249
|
+
isShowing: boolean;
|
|
18250
|
+
/**
|
|
18251
|
+
* The left-most coordinate of the window.
|
|
18252
|
+
*/
|
|
18253
|
+
left: number;
|
|
18254
|
+
/**
|
|
18255
|
+
* The name of the window.
|
|
18256
|
+
*/
|
|
18257
|
+
name: string;
|
|
18258
|
+
/**
|
|
18259
|
+
* The right-most coordinate of the window.
|
|
18260
|
+
*/
|
|
18261
|
+
right: number;
|
|
18262
|
+
state: string;
|
|
18263
|
+
/**
|
|
18264
|
+
* The top-most coordinate of the window.
|
|
18265
|
+
*/
|
|
18266
|
+
top: number;
|
|
18267
|
+
/**
|
|
18268
|
+
* The width of the window.
|
|
18269
|
+
*/
|
|
18270
|
+
width: number;
|
|
18271
|
+
};
|
|
18272
|
+
|
|
18273
|
+
/**
|
|
18274
|
+
* Generated when a child window ends loading.
|
|
18275
|
+
* @interface
|
|
18276
|
+
*/
|
|
18277
|
+
declare type WindowEndLoadEvent = BaseEvent_3 & {
|
|
18278
|
+
type: 'window-end-load';
|
|
18279
|
+
};
|
|
18280
|
+
|
|
18281
|
+
/**
|
|
18282
|
+
* @deprecated, Renamed to {@link Event}.
|
|
18283
|
+
*/
|
|
18284
|
+
declare type WindowEvent = Event_6;
|
|
18285
|
+
|
|
18286
|
+
declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
|
|
18287
|
+
|
|
18288
|
+
declare namespace WindowEvents {
|
|
18289
|
+
export {
|
|
18290
|
+
BaseEvent_5 as BaseEvent,
|
|
18291
|
+
BaseWindowEvent,
|
|
18292
|
+
ViewAttachedEvent,
|
|
18293
|
+
ViewDetachedEvent,
|
|
18294
|
+
WindowViewEvent,
|
|
18295
|
+
AlertRequestedEvent,
|
|
18296
|
+
AuthRequestedEvent,
|
|
18297
|
+
EndLoadEvent,
|
|
18298
|
+
WillRedirectEvent,
|
|
18299
|
+
ReloadedEvent,
|
|
18300
|
+
OptionsChangedEvent,
|
|
18301
|
+
WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
|
|
18302
|
+
ExternalProcessExitedEvent,
|
|
18303
|
+
ExternalProcessStartedEvent,
|
|
18304
|
+
HiddenEvent_2 as HiddenEvent,
|
|
18305
|
+
WindowHiddenEvent,
|
|
18306
|
+
PreloadScriptInfoRunning,
|
|
18307
|
+
PreloadScriptInfo,
|
|
18308
|
+
PreloadScriptsStateChangeEvent,
|
|
18309
|
+
UserBoundsChangeEvent,
|
|
18310
|
+
BoundsChangeEvent,
|
|
18311
|
+
WillMoveOrResizeEvent,
|
|
18312
|
+
PerformanceReportEvent,
|
|
18313
|
+
InputEvent_2 as InputEvent,
|
|
18314
|
+
LayoutInitializedEvent,
|
|
18315
|
+
LayoutReadyEvent,
|
|
18316
|
+
BeginUserBoundsChangingEvent,
|
|
18317
|
+
BoundsChangedEvent,
|
|
18318
|
+
BoundsChangingEvent,
|
|
18319
|
+
CloseRequestedEvent,
|
|
18320
|
+
WindowCloseRequestedEvent,
|
|
18321
|
+
ContextChangedEvent,
|
|
18322
|
+
ClosedEvent_2 as ClosedEvent,
|
|
18323
|
+
WindowClosedEvent,
|
|
18324
|
+
ClosingEvent,
|
|
18325
|
+
WindowClosingEvent,
|
|
18326
|
+
DisabledMovementBoundsChangedEvent,
|
|
18327
|
+
DisabledMovementBoundsChangingEvent,
|
|
18328
|
+
EmbeddedEvent,
|
|
18329
|
+
EndUserBoundsChangingEvent,
|
|
18330
|
+
HotkeyEvent_2 as HotkeyEvent,
|
|
18331
|
+
WindowHotkeyEvent,
|
|
18332
|
+
InitializedEvent_2 as InitializedEvent,
|
|
18333
|
+
WindowInitializedEvent,
|
|
18334
|
+
MaximizedEvent,
|
|
18335
|
+
MinimizedEvent,
|
|
18336
|
+
PreloadScriptsStateChangedEvent,
|
|
18337
|
+
PreloadScriptsStateChangingEvent,
|
|
18338
|
+
RestoredEvent,
|
|
18339
|
+
WindowRestoredEvent,
|
|
18340
|
+
ShowRequestedEvent,
|
|
18341
|
+
WindowShowRequestedEvent,
|
|
18342
|
+
ShownEvent_2 as ShownEvent,
|
|
18343
|
+
WindowShownEvent,
|
|
18344
|
+
UserMovementEnabledEvent,
|
|
18345
|
+
UserMovementDisabledEvent,
|
|
18346
|
+
WillMoveEvent,
|
|
18347
|
+
WillResizeEvent,
|
|
18348
|
+
NonPropagatedWindowEvent,
|
|
18349
|
+
ShowAllDownloadsEvent,
|
|
18350
|
+
DownloadShelfVisibilityChangedEvent,
|
|
18351
|
+
WindowSourcedEvent,
|
|
18352
|
+
WillPropagateWindowEvent,
|
|
18353
|
+
Event_6 as Event,
|
|
18354
|
+
WindowEvent,
|
|
18355
|
+
EventType_2 as EventType,
|
|
18356
|
+
WindowEventType,
|
|
18357
|
+
PropagatedEvent_3 as PropagatedEvent,
|
|
18358
|
+
PropagatedWindowEvent,
|
|
18359
|
+
PropagatedWindowEventType,
|
|
18360
|
+
Payload_3 as Payload,
|
|
18361
|
+
ByType_2 as ByType
|
|
18362
|
+
}
|
|
18363
|
+
}
|
|
18364
|
+
|
|
18365
|
+
/**
|
|
18366
|
+
* @deprecated Renamed to {@link EventType}.
|
|
18367
|
+
*/
|
|
18368
|
+
declare type WindowEventType = WindowEvent['type'];
|
|
18369
|
+
|
|
18370
|
+
/**
|
|
18371
|
+
* @deprecated Renamed to {@link HiddenEvent}.
|
|
18372
|
+
*/
|
|
18373
|
+
declare type WindowHiddenEvent = HiddenEvent_2;
|
|
18374
|
+
|
|
18375
|
+
/**
|
|
18376
|
+
* @deprecated Renamed to {@link HotkeyEvent}.
|
|
18377
|
+
*/
|
|
18378
|
+
declare type WindowHotkeyEvent = HotkeyEvent_2;
|
|
18379
|
+
|
|
18380
|
+
/**
|
|
18381
|
+
* @interface
|
|
18382
|
+
*/
|
|
18383
|
+
declare type WindowInfo = {
|
|
18384
|
+
canNavigateBack: boolean;
|
|
18385
|
+
canNavigateForward: boolean;
|
|
18386
|
+
preloadScripts: Array<any>;
|
|
18387
|
+
title: string;
|
|
18388
|
+
url: string;
|
|
18389
|
+
};
|
|
18390
|
+
|
|
18391
|
+
/**
|
|
18392
|
+
* @deprecated Renamed to {@link InitializedEvent}.
|
|
18393
|
+
*/
|
|
18394
|
+
declare type WindowInitializedEvent = InitializedEvent_2;
|
|
18395
|
+
|
|
18396
|
+
/**
|
|
18397
|
+
* Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
|
|
18398
|
+
*/
|
|
18399
|
+
declare class _WindowModule extends Base {
|
|
18400
|
+
/**
|
|
18401
|
+
* Asynchronously returns a Window object that represents an existing window.
|
|
18402
|
+
*
|
|
18403
|
+
* @example
|
|
18404
|
+
* ```js
|
|
18405
|
+
* async function createWin() {
|
|
18406
|
+
* const app = await fin.Application.start({
|
|
18407
|
+
* name: 'myApp',
|
|
18408
|
+
* uuid: 'app-1',
|
|
18409
|
+
* url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrap.html',
|
|
18410
|
+
* autoShow: true
|
|
18411
|
+
* });
|
|
18412
|
+
* return await app.getWindow();
|
|
18413
|
+
* }
|
|
18414
|
+
* createWin().then(() => fin.Window.wrap({ uuid: 'app-1', name: 'myApp' }))
|
|
18415
|
+
* .then(win => console.log('wrapped window'))
|
|
18416
|
+
* .catch(err => console.log(err));
|
|
18417
|
+
* ```
|
|
18418
|
+
*/
|
|
18419
|
+
wrap(identity: OpenFin_2.Identity): Promise<OpenFin_2.Window>;
|
|
18420
|
+
/**
|
|
18421
|
+
* Synchronously returns a Window object that represents an existing window.
|
|
18422
|
+
*
|
|
18423
|
+
* @example
|
|
18424
|
+
* ```js
|
|
18425
|
+
* async function createWin() {
|
|
18426
|
+
* const app = await fin.Application.start({
|
|
18427
|
+
* name: 'myApp',
|
|
18428
|
+
* uuid: 'app-1',
|
|
18429
|
+
* url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrapSync.html',
|
|
18430
|
+
* autoShow: true
|
|
18431
|
+
* });
|
|
18432
|
+
* return await app.getWindow();
|
|
18433
|
+
* }
|
|
18434
|
+
* await createWin();
|
|
18435
|
+
* let win = fin.Window.wrapSync({ uuid: 'app-1', name: 'myApp' });
|
|
18436
|
+
* ```
|
|
18437
|
+
*/
|
|
18438
|
+
wrapSync(identity: OpenFin_2.Identity): OpenFin_2.Window;
|
|
18439
|
+
/**
|
|
18440
|
+
* Creates a new Window.
|
|
18441
|
+
* @param options - Window creation options
|
|
18442
|
+
*
|
|
18443
|
+
* @example
|
|
18444
|
+
* ```js
|
|
18445
|
+
* async function createWindow() {
|
|
18446
|
+
* const winOption = {
|
|
18447
|
+
* name:'child',
|
|
18448
|
+
* defaultWidth: 300,
|
|
18449
|
+
* defaultHeight: 300,
|
|
18450
|
+
* url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.create.html',
|
|
18451
|
+
* frame: true,
|
|
18452
|
+
* autoShow: true
|
|
18453
|
+
* };
|
|
18454
|
+
* return await fin.Window.create(winOption);
|
|
18455
|
+
* }
|
|
18456
|
+
*
|
|
18457
|
+
* createWindow().then(() => console.log('Window is created')).catch(err => console.log(err));
|
|
18458
|
+
* ```
|
|
18459
|
+
*/
|
|
18460
|
+
create(options: OpenFin_2.WindowCreationOptions): Promise<OpenFin_2.Window>;
|
|
18461
|
+
/**
|
|
18462
|
+
* Asynchronously returns a Window object that represents the current window
|
|
18463
|
+
*
|
|
18464
|
+
* @example
|
|
18465
|
+
* ```js
|
|
18466
|
+
* fin.Window.getCurrent()
|
|
18467
|
+
* .then(wnd => console.log('current window'))
|
|
18468
|
+
* .catch(err => console.log(err));
|
|
18469
|
+
*
|
|
18470
|
+
* ```
|
|
18471
|
+
*/
|
|
18472
|
+
getCurrent(): Promise<OpenFin_2.Window>;
|
|
18473
|
+
/**
|
|
18474
|
+
* Synchronously returns a Window object that represents the current window
|
|
18475
|
+
*
|
|
18476
|
+
* @example
|
|
18477
|
+
* ```js
|
|
18478
|
+
* const wnd = fin.Window.getCurrentSync();
|
|
18479
|
+
* const info = await wnd.getInfo();
|
|
18480
|
+
* console.log(info);
|
|
18481
|
+
*
|
|
18482
|
+
* ```
|
|
18483
|
+
*/
|
|
18484
|
+
getCurrentSync(): OpenFin_2.Window;
|
|
18485
|
+
}
|
|
18486
|
+
|
|
18487
|
+
/**
|
|
18488
|
+
* Generated when a child window is not responding.
|
|
18489
|
+
* @interface
|
|
18490
|
+
*/
|
|
18491
|
+
declare type WindowNotRespondingEvent = BaseEvent_3 & {
|
|
18492
|
+
type: 'window-not-responding';
|
|
18493
|
+
};
|
|
18494
|
+
|
|
18495
|
+
/**
|
|
18496
|
+
* @interface
|
|
18497
|
+
*/
|
|
18498
|
+
declare type WindowOptionDiff = {
|
|
18499
|
+
[key in keyof WindowOptions]: {
|
|
18500
|
+
oldVal: WindowOptions[key];
|
|
18501
|
+
newVal: WindowOptions[key];
|
|
18502
|
+
};
|
|
18503
|
+
};
|
|
18504
|
+
|
|
18505
|
+
/**
|
|
18506
|
+
* @interface
|
|
18507
|
+
*/
|
|
18508
|
+
declare type WindowOptions = MutableWindowOptions & ConstWindowOptions;
|
|
18509
|
+
|
|
18510
|
+
declare type WindowOptionsChangedEvent = OpenFin_2.WindowEvents.WindowOptionsChangedEvent;
|
|
18511
|
+
|
|
18512
|
+
/**
|
|
18513
|
+
* @deprecated Renamed to {@link OptionsChangedEvent}.
|
|
18514
|
+
*/
|
|
18515
|
+
declare type WindowOptionsChangedEvent_2 = OptionsChangedEvent;
|
|
18516
|
+
|
|
18517
|
+
declare type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
|
|
18518
|
+
|
|
18519
|
+
/**
|
|
18520
|
+
* Generated when a child window is responding.
|
|
18521
|
+
* @interface
|
|
18522
|
+
*/
|
|
18523
|
+
declare type WindowRespondingEvent = BaseEvent_3 & {
|
|
18524
|
+
type: 'window-responding';
|
|
18525
|
+
};
|
|
18526
|
+
|
|
18527
|
+
/**
|
|
18528
|
+
* @deprecated Renamed to {@link RestoredEvent}.
|
|
18529
|
+
*/
|
|
18530
|
+
declare type WindowRestoredEvent = RestoredEvent;
|
|
18531
|
+
|
|
18532
|
+
/**
|
|
18533
|
+
* @deprecated Renamed to {@link ShownEvent}.
|
|
18534
|
+
*/
|
|
18535
|
+
declare type WindowShownEvent = ShownEvent_2;
|
|
18536
|
+
|
|
18537
|
+
/**
|
|
18538
|
+
* @deprecated Renamed to {@link ShowRequestedEvent}.
|
|
18539
|
+
*/
|
|
18540
|
+
declare type WindowShowRequestedEvent = ShowRequestedEvent;
|
|
18541
|
+
|
|
18542
|
+
/**
|
|
18543
|
+
* A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
|
|
18544
|
+
* from {@link OpenFin.ViewEvents}.
|
|
18545
|
+
*/
|
|
18546
|
+
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;
|
|
18547
|
+
|
|
18548
|
+
/**
|
|
18549
|
+
* Generated when a child window starts loading.
|
|
18550
|
+
* @interface
|
|
18551
|
+
*/
|
|
18552
|
+
declare type WindowStartLoadEvent = BaseEvent_3 & {
|
|
18553
|
+
type: 'window-start-load';
|
|
18554
|
+
};
|
|
18555
|
+
|
|
18556
|
+
/**
|
|
18557
|
+
* Visibility state of a window.
|
|
18558
|
+
*/
|
|
18559
|
+
declare type WindowState = 'maximized' | 'minimized' | 'normal';
|
|
18560
|
+
|
|
18561
|
+
/**
|
|
18562
|
+
* A view-related event that fires natively on the `Window` topic. This means that these events *do* propagate
|
|
18563
|
+
* to the `Application` level, with the name pattern `window-view-eventname`.
|
|
18564
|
+
*/
|
|
18565
|
+
declare type WindowViewEvent = {
|
|
18566
|
+
viewIdentity: OpenFin_2.Identity;
|
|
18567
|
+
} & (ViewAttachedEvent | ViewDetachedEvent);
|
|
18568
|
+
|
|
18569
|
+
/**
|
|
18570
|
+
* @interface
|
|
18571
|
+
*/
|
|
18572
|
+
declare type WindowViewsPrintOptions = {
|
|
18573
|
+
content: 'views';
|
|
18574
|
+
includeSelf?: boolean;
|
|
18575
|
+
};
|
|
18576
|
+
|
|
18577
|
+
declare type Wire = EventEmitter & {
|
|
18578
|
+
connect(messageReciever: MessageReceiver): Promise<any>;
|
|
18579
|
+
connectSync(): any;
|
|
18580
|
+
send(data: any): Promise<any>;
|
|
18581
|
+
shutdown(): Promise<void>;
|
|
18582
|
+
getPort(): string;
|
|
18583
|
+
};
|
|
18584
|
+
|
|
18585
|
+
declare type WireConstructor = {
|
|
18586
|
+
new (onmessage: (data: any) => void): Wire;
|
|
18587
|
+
};
|
|
18588
|
+
|
|
18589
|
+
/* Excluded from this release type: WithId */
|
|
18590
|
+
|
|
18591
|
+
declare interface WithInterop {
|
|
18592
|
+
interop: InteropClient;
|
|
18593
|
+
}
|
|
18594
|
+
|
|
18595
|
+
/* Excluded from this release type: WithoutId */
|
|
18596
|
+
|
|
18597
|
+
declare type WithPositioningOptions<T extends {} = {}> = T & {
|
|
18598
|
+
positioningOptions?: OpenFin_2.PositioningOptions;
|
|
18599
|
+
};
|
|
18600
|
+
|
|
18601
|
+
/* Excluded from this release type: WorkspacePlatformOptions */
|
|
18602
|
+
|
|
18603
|
+
/**
|
|
18604
|
+
* A generic request to write any supported data to the clipboard.
|
|
18605
|
+
* @interface
|
|
18606
|
+
*/
|
|
18607
|
+
declare type WriteAnyClipboardRequest = BaseClipboardRequest & {
|
|
18608
|
+
/**
|
|
18609
|
+
* Data to be written
|
|
18610
|
+
*/
|
|
18611
|
+
data: {
|
|
18612
|
+
text?: string;
|
|
18613
|
+
html?: string;
|
|
18614
|
+
rtf?: string;
|
|
18615
|
+
} & Partial<Pick<WriteImageClipboardRequest, 'image'>>;
|
|
18616
|
+
};
|
|
18617
|
+
|
|
18618
|
+
/**
|
|
18619
|
+
* @deprecated - instead use WriteAnyClipboardRequest
|
|
18620
|
+
*
|
|
18621
|
+
* A generic request to write any supported data to the clipboard.
|
|
18622
|
+
*
|
|
18623
|
+
* @interface
|
|
18624
|
+
*/
|
|
18625
|
+
declare type WriteAnyRequestType = WriteAnyClipboardRequest;
|
|
18626
|
+
|
|
18627
|
+
/**
|
|
18628
|
+
* A request to write data to the clipboard.
|
|
18629
|
+
* @interface
|
|
18630
|
+
*/
|
|
18631
|
+
declare type WriteClipboardRequest = BaseClipboardRequest & {
|
|
18632
|
+
/**
|
|
18633
|
+
* Data to write to the clipboard.
|
|
18634
|
+
*/
|
|
18635
|
+
data: string;
|
|
18636
|
+
};
|
|
18637
|
+
|
|
18638
|
+
/**
|
|
18639
|
+
* @interface
|
|
18640
|
+
*/
|
|
18641
|
+
declare type WriteImageClipboardRequest = BaseClipboardRequest & {
|
|
18642
|
+
/**
|
|
18643
|
+
* Can be either a base64 string, or a DataURL string. If using DataURL, the
|
|
18644
|
+
* supported formats are `data:image/png[;base64],` and `data:image/jpeg[;base64],`.
|
|
18645
|
+
* Using other image/<format> DataURLs will throw an Error.
|
|
18646
|
+
*/
|
|
18647
|
+
image: string;
|
|
18648
|
+
};
|
|
18649
|
+
|
|
18650
|
+
/**
|
|
18651
|
+
* @deprecated - instead use OpenFin.WriteClipboardRequest
|
|
18652
|
+
*
|
|
18653
|
+
* A request to write data to the clipboard.
|
|
18654
|
+
*
|
|
18655
|
+
* @interface
|
|
18656
|
+
*/
|
|
18657
|
+
declare type WriteRequestType = WriteClipboardRequest;
|
|
18658
|
+
|
|
18659
|
+
export { }
|