@openfin/core 35.78.2 → 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 +750 -1824
- package/out/mock-beta.d.ts +750 -1824
- package/out/mock-public.d.ts +750 -1824
- package/out/mock.d.ts +775 -2040
- package/out/mock.js +86 -1422
- package/package.json +2 -2
package/out/mock.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 & {
|
|
@@ -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,13 @@ 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
|
+
|
|
108
121
|
/**
|
|
109
122
|
* Generated when a new Platform's API becomes responsive.
|
|
110
123
|
* @interface
|
|
@@ -193,100 +206,6 @@ declare class Application extends EmitterBase<OpenFin_2.ApplicationEvent> {
|
|
|
193
206
|
*/
|
|
194
207
|
constructor(wire: Transport, identity: OpenFin_2.ApplicationIdentity);
|
|
195
208
|
private windowListFromIdentityList;
|
|
196
|
-
/**
|
|
197
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
|
198
|
-
* @param eventType - The type of the event.
|
|
199
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
|
200
|
-
* @param options - Option to support event timestamps.
|
|
201
|
-
*
|
|
202
|
-
* @function addListener
|
|
203
|
-
* @memberof Application
|
|
204
|
-
* @instance
|
|
205
|
-
* @tutorial Application.EventEmitter
|
|
206
|
-
*/
|
|
207
|
-
/**
|
|
208
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
|
209
|
-
* @param eventType - The type of the event.
|
|
210
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
|
211
|
-
* @param options - Option to support event timestamps.
|
|
212
|
-
*
|
|
213
|
-
* @function on
|
|
214
|
-
* @memberof Application
|
|
215
|
-
* @instance
|
|
216
|
-
* @tutorial Application.EventEmitter
|
|
217
|
-
*/
|
|
218
|
-
/**
|
|
219
|
-
* 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.
|
|
220
|
-
* @param eventType - The type of the event.
|
|
221
|
-
* @param listener - The callback function.
|
|
222
|
-
* @param options - Option to support event timestamps.
|
|
223
|
-
*
|
|
224
|
-
* @function once
|
|
225
|
-
* @memberof Application
|
|
226
|
-
* @instance
|
|
227
|
-
* @tutorial Application.EventEmitter
|
|
228
|
-
*/
|
|
229
|
-
/**
|
|
230
|
-
* Adds a listener to the beginning of the listeners array for the specified event.
|
|
231
|
-
* @param eventType - The type of the event.
|
|
232
|
-
* @param listener - The callback function.
|
|
233
|
-
* @param options - Option to support event timestamps.
|
|
234
|
-
*
|
|
235
|
-
* @function prependListener
|
|
236
|
-
* @memberof Application
|
|
237
|
-
* @instance
|
|
238
|
-
* @tutorial Application.EventEmitter
|
|
239
|
-
*/
|
|
240
|
-
/**
|
|
241
|
-
* 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.
|
|
242
|
-
* The listener is added to the beginning of the listeners array.
|
|
243
|
-
* @param eventType - The type of the event.
|
|
244
|
-
* @param listener - The callback function.
|
|
245
|
-
* @param options - Option to support event timestamps.
|
|
246
|
-
*
|
|
247
|
-
* @function prependOnceListener
|
|
248
|
-
* @memberof Application
|
|
249
|
-
* @instance
|
|
250
|
-
* @tutorial Application.EventEmitter
|
|
251
|
-
*/
|
|
252
|
-
/**
|
|
253
|
-
* Remove a listener from the listener array for the specified event.
|
|
254
|
-
* Caution: Calling this method changes the array indices in the listener array behind the listener.
|
|
255
|
-
* @param eventType - The type of the event.
|
|
256
|
-
* @param listener - The callback function.
|
|
257
|
-
* @param options - Option to support event timestamps.
|
|
258
|
-
*
|
|
259
|
-
* @function removeListener
|
|
260
|
-
* @memberof Application
|
|
261
|
-
* @instance
|
|
262
|
-
* @tutorial Application.EventEmitter
|
|
263
|
-
*/
|
|
264
|
-
/**
|
|
265
|
-
* Removes all listeners, or those of the specified event.
|
|
266
|
-
* @param eventType - The type of the event.
|
|
267
|
-
*
|
|
268
|
-
* @function removeAllListeners
|
|
269
|
-
* @memberof Application
|
|
270
|
-
* @instance
|
|
271
|
-
* @tutorial Application.EventEmitter
|
|
272
|
-
*/
|
|
273
|
-
/**
|
|
274
|
-
* JumpListCategory interface
|
|
275
|
-
* @typedef { object } JumpListCategory@typedef { object } JumpListCategory
|
|
276
|
-
* @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.
|
|
277
|
-
* @property { JumpListItem[] } items Array of JumpListItem objects
|
|
278
|
-
*/
|
|
279
|
-
/**
|
|
280
|
-
* @PORTED
|
|
281
|
-
* JumpListItem interface
|
|
282
|
-
* @typedef { object } JumpListItem@typedef { object } JumpListItem
|
|
283
|
-
* @property { string } type One of the following: "task" or "separator". Defaults to task.
|
|
284
|
-
* @property { string } title The text to be displayed for the JumpList Item. Should only be set if type is "task".
|
|
285
|
-
* @property { string } description Description of the task (displayed in a tooltip). Should only be set if type is "task".
|
|
286
|
-
* @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.
|
|
287
|
-
* @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).
|
|
288
|
-
* @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.
|
|
289
|
-
*/
|
|
290
209
|
/**
|
|
291
210
|
* Determines if the application is currently running.
|
|
292
211
|
*
|
|
@@ -924,7 +843,6 @@ declare namespace ApplicationEvents {
|
|
|
924
843
|
WindowRespondingEvent,
|
|
925
844
|
WindowStartLoadEvent,
|
|
926
845
|
ApplicationWindowEvent,
|
|
927
|
-
ApplicationWindowEventTypes,
|
|
928
846
|
ClosedEvent,
|
|
929
847
|
ConnectedEvent_2 as ConnectedEvent,
|
|
930
848
|
ApplicationConnectedEvent,
|
|
@@ -934,6 +852,7 @@ declare namespace ApplicationEvents {
|
|
|
934
852
|
RespondingEvent,
|
|
935
853
|
StartedEvent,
|
|
936
854
|
ApplicationSourcedEvent,
|
|
855
|
+
ApplicationSourcedEventType,
|
|
937
856
|
Event_3 as Event,
|
|
938
857
|
ApplicationEvent,
|
|
939
858
|
EventType_3 as EventType,
|
|
@@ -1272,10 +1191,13 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1272
1191
|
*/
|
|
1273
1192
|
apiDiagnostics: boolean;
|
|
1274
1193
|
/**
|
|
1275
|
-
*
|
|
1276
|
-
* See [here](https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads) for more details.
|
|
1194
|
+
* @deprecated Please use {@link domainSettings} instead
|
|
1277
1195
|
*/
|
|
1278
1196
|
defaultDomainSettings: DefaultDomainSettings;
|
|
1197
|
+
/**
|
|
1198
|
+
* 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.
|
|
1199
|
+
*/
|
|
1200
|
+
domainSettings: DomainSettings;
|
|
1279
1201
|
/**
|
|
1280
1202
|
* @defaultValue false
|
|
1281
1203
|
*
|
|
@@ -1306,6 +1228,11 @@ declare type ApplicationPermissions = {
|
|
|
1306
1228
|
*/
|
|
1307
1229
|
declare type ApplicationSourcedEvent = ClosedEvent | ConnectedEvent_2 | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent_2 | StartedEvent | TrayIconClickedEvent | FileDownloadLocationChangedEvent;
|
|
1308
1230
|
|
|
1231
|
+
/**
|
|
1232
|
+
* Union of possible type values for an {@link ApplicationSourcedEvent}.
|
|
1233
|
+
*/
|
|
1234
|
+
declare type ApplicationSourcedEventType = ApplicationSourcedEvent['type'];
|
|
1235
|
+
|
|
1309
1236
|
declare type ApplicationState = OpenFin_2.ApplicationState;
|
|
1310
1237
|
|
|
1311
1238
|
/**
|
|
@@ -1343,11 +1270,6 @@ declare type ApplicationType = {
|
|
|
1343
1270
|
*/
|
|
1344
1271
|
declare type ApplicationWindowEvent = WindowAlertRequestedEvent | WindowCreatedEvent | WindowEndLoadEvent | WindowNotRespondingEvent | WindowRespondingEvent | WindowStartLoadEvent;
|
|
1345
1272
|
|
|
1346
|
-
/**
|
|
1347
|
-
* Array of valid `type` values for an {@link ApplicationWindowEvent}.
|
|
1348
|
-
*/
|
|
1349
|
-
declare const ApplicationWindowEventTypes: readonly ["window-alert-requested", "window-created", "window-end-load", "window-not-responding", "window-responding", "window-start-load"];
|
|
1350
|
-
|
|
1351
1273
|
declare type ApplicationWindowInfo = OpenFin_2.ApplicationWindowInfo;
|
|
1352
1274
|
|
|
1353
1275
|
/**
|
|
@@ -3148,20 +3070,6 @@ declare type ClientInfo = Omit<ClientIdentity, 'isLocalEndpointId'> & {
|
|
|
3148
3070
|
connectionUrl: string;
|
|
3149
3071
|
};
|
|
3150
3072
|
|
|
3151
|
-
/**
|
|
3152
|
-
* @PORTED
|
|
3153
|
-
* WriteRequestType interface
|
|
3154
|
-
* @typedef { object } WriteRequestType@typedef { object } WriteRequestType
|
|
3155
|
-
* @property { string } data Data to be written
|
|
3156
|
-
* @property { string } [type] Clipboard Type
|
|
3157
|
-
*/
|
|
3158
|
-
/**
|
|
3159
|
-
* @PORTED
|
|
3160
|
-
* OpenFin.WriteAnyClipboardRequest interface
|
|
3161
|
-
* @typedef { object } OpenFin.WriteAnyClipboardRequest@typedef { object } OpenFin.WriteAnyClipboardRequest
|
|
3162
|
-
* @property { string } data Data to be written
|
|
3163
|
-
* @property { OpenFin.ClipboardSelectionType } [type] Clipboard Type defaults to 'clipboard', use 'selection' for linux
|
|
3164
|
-
*/
|
|
3165
3073
|
/**
|
|
3166
3074
|
* The Clipboard API allows reading and writing to the clipboard in multiple formats.
|
|
3167
3075
|
*
|
|
@@ -3417,57 +3325,6 @@ declare type ClosingEvent = BaseEvent_5 & {
|
|
|
3417
3325
|
*/
|
|
3418
3326
|
declare class ColumnOrRow extends LayoutNode {
|
|
3419
3327
|
#private;
|
|
3420
|
-
/**
|
|
3421
|
-
* Determines if this {@link ColumnOrRow} is the top level content item in the current layout.
|
|
3422
|
-
* @function isRoot
|
|
3423
|
-
* @memberof ColumnOrRow
|
|
3424
|
-
* @instance
|
|
3425
|
-
* @tutorial ColumnOrRow.isRoot
|
|
3426
|
-
* @returns Resolves true if this TabStack is the top level content item, or false if it is not.
|
|
3427
|
-
*/
|
|
3428
|
-
/**
|
|
3429
|
-
* Determines if this {@link ColumnOrRow} exists.
|
|
3430
|
-
* @function exists
|
|
3431
|
-
* @instance
|
|
3432
|
-
* @memberof ColumnOrRow
|
|
3433
|
-
* @tutorial ColumnOrRow.exists
|
|
3434
|
-
* @returns Resolves true if the TabStack exists, or false if it has been destroyed.
|
|
3435
|
-
*/
|
|
3436
|
-
/**
|
|
3437
|
-
* Retrieves the parent {@link ColumnOrRow} of this {@link ColumnOrRow}, if one exists.
|
|
3438
|
-
* @function getParent
|
|
3439
|
-
* @instance
|
|
3440
|
-
* @memberof ColumnOrRow
|
|
3441
|
-
* @tutorial ColumnOrRow.getParent
|
|
3442
|
-
* @returns Promise resolving with the {@link ColumnOrRow} that contains this item, or undefined if
|
|
3443
|
-
* this {@link ColumnOrRow}does not exist or is the root content item.
|
|
3444
|
-
*/
|
|
3445
|
-
/**
|
|
3446
|
-
* Returns all the adjacent stacks that share an edge with the given {@link ColumnOrRow}.
|
|
3447
|
-
* @function getAdjacentStacks
|
|
3448
|
-
* @instance
|
|
3449
|
-
* @memberof ColumnOrRow
|
|
3450
|
-
* @param {LayoutPosition} edge - Edge to check for any adjacent stacks.
|
|
3451
|
-
*
|
|
3452
|
-
* @tutorial ColumnOrRow.getAdjacentStacks
|
|
3453
|
-
*/
|
|
3454
|
-
/**
|
|
3455
|
-
* Given a list of view creation options or references and a layout position, creates a {@link TabStack} adjacent to the given {@link ColumnOrRow}
|
|
3456
|
-
*
|
|
3457
|
-
* Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
|
|
3458
|
-
* during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
|
|
3459
|
-
* This means the views you pass to createAdjacentStack() may not render in the order given by the array.
|
|
3460
|
-
* Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
|
|
3461
|
-
*
|
|
3462
|
-
* @function createAdjacentStack
|
|
3463
|
-
* @instance
|
|
3464
|
-
* @memberof ColumnOrRow
|
|
3465
|
-
* @param views - List of identities or view creation options of the views to include in the stack
|
|
3466
|
-
* @param options - Creation options.
|
|
3467
|
-
* @returns The created TabStack
|
|
3468
|
-
* @tutorial ColumnOrRow.createAdjacentStack
|
|
3469
|
-
* @experimental
|
|
3470
|
-
*/
|
|
3471
3328
|
/**
|
|
3472
3329
|
* @internal
|
|
3473
3330
|
*/
|
|
@@ -3588,6 +3445,10 @@ declare type ConstructorOverride<T> = (Base: Constructor<T>) => Constructor<T>;
|
|
|
3588
3445
|
* @interface
|
|
3589
3446
|
*/
|
|
3590
3447
|
declare type ConstViewOptions = {
|
|
3448
|
+
/**
|
|
3449
|
+
* Configurations for API injection.
|
|
3450
|
+
*/
|
|
3451
|
+
api: Api;
|
|
3591
3452
|
/**
|
|
3592
3453
|
* The name of the view.
|
|
3593
3454
|
*/
|
|
@@ -3668,9 +3529,13 @@ declare type ConstViewOptions = {
|
|
|
3668
3529
|
/**
|
|
3669
3530
|
* Controls interaction of the view with its parent window's download shelf.
|
|
3670
3531
|
*/
|
|
3671
|
-
downloadShelf
|
|
3532
|
+
downloadShelf: {
|
|
3672
3533
|
/**
|
|
3673
|
-
* Whether downloads in this view trigger opening the download shelf on its parent BrowserWindow
|
|
3534
|
+
* Whether downloads in this view trigger opening the download shelf on its parent BrowserWindow.
|
|
3535
|
+
*
|
|
3536
|
+
* @remarks If `enabled: true`, downloads from this view will cause the download shelf to display
|
|
3537
|
+
* on the parent window even if that parent window's {@link DownloadShelfOptions} specify
|
|
3538
|
+
* `enabled: false`.
|
|
3674
3539
|
*/
|
|
3675
3540
|
enabled: boolean;
|
|
3676
3541
|
};
|
|
@@ -3736,7 +3601,7 @@ declare type ConstWindowOptions = {
|
|
|
3736
3601
|
/**
|
|
3737
3602
|
* @defaultValue true
|
|
3738
3603
|
*
|
|
3739
|
-
*
|
|
3604
|
+
* Setting this to false would keep the Window alive even if all its Views were closed.
|
|
3740
3605
|
* This is meant for advanced users and should be used with caution.
|
|
3741
3606
|
* Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
|
|
3742
3607
|
* Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
|
|
@@ -3746,7 +3611,8 @@ declare type ConstWindowOptions = {
|
|
|
3746
3611
|
/**
|
|
3747
3612
|
* @defaultValue 'all'
|
|
3748
3613
|
*
|
|
3749
|
-
*
|
|
3614
|
+
* When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
|
|
3615
|
+
+ * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
|
|
3750
3616
|
* **NOTE:** - This option is ignored in non-Platforms apps.
|
|
3751
3617
|
*/
|
|
3752
3618
|
viewsPreventingClose: 'all' | 'layout';
|
|
@@ -3785,6 +3651,12 @@ declare type ConstWindowOptions = {
|
|
|
3785
3651
|
* launches in favor of the cached value.
|
|
3786
3652
|
*/
|
|
3787
3653
|
defaultWidth: number;
|
|
3654
|
+
/**
|
|
3655
|
+
* Controls the styling and behavior of the window download shelf.
|
|
3656
|
+
*
|
|
3657
|
+
* @remarks This will control the styling for the download shelf regardless of whether its display was
|
|
3658
|
+
* triggered by the window itself, or a view targeting the window.
|
|
3659
|
+
*/
|
|
3788
3660
|
downloadShelf: DownloadShelfOptions;
|
|
3789
3661
|
height: number;
|
|
3790
3662
|
layout: any;
|
|
@@ -4553,7 +4425,7 @@ declare type CreateViewPayload = {
|
|
|
4553
4425
|
/**
|
|
4554
4426
|
* @interface
|
|
4555
4427
|
*/
|
|
4556
|
-
declare type CreateViewTarget = LayoutIdentity & {
|
|
4428
|
+
declare type CreateViewTarget = (Identity_5 | LayoutIdentity) & {
|
|
4557
4429
|
/**
|
|
4558
4430
|
* If specified, view creation will not attach to a window and caller must
|
|
4559
4431
|
* insert the view into the layout explicitly
|
|
@@ -4622,21 +4494,15 @@ declare type CustomRequestHeaders = {
|
|
|
4622
4494
|
declare type DataChannelReadyState = RTCDataChannel['readyState'];
|
|
4623
4495
|
|
|
4624
4496
|
/**
|
|
4497
|
+
* @deprecated Use {@link OpenFin.DomainSettings} instead.
|
|
4625
4498
|
* @interface
|
|
4626
4499
|
*/
|
|
4627
|
-
declare type DefaultDomainSettings =
|
|
4628
|
-
rules: DefaultDomainSettingsRule[];
|
|
4629
|
-
};
|
|
4500
|
+
declare type DefaultDomainSettings = DomainSettings;
|
|
4630
4501
|
|
|
4631
4502
|
/**
|
|
4632
|
-
* @
|
|
4503
|
+
* @deprecated Use {@link OpenFin.DomainSettingsRule} instead.
|
|
4633
4504
|
*/
|
|
4634
|
-
declare type DefaultDomainSettingsRule =
|
|
4635
|
-
match: string[];
|
|
4636
|
-
options: {
|
|
4637
|
-
downloadSettings: FileDownloadSettings;
|
|
4638
|
-
};
|
|
4639
|
-
};
|
|
4505
|
+
declare type DefaultDomainSettingsRule = DomainSettingsRule;
|
|
4640
4506
|
|
|
4641
4507
|
declare interface DesktopAgent {
|
|
4642
4508
|
open(app: TargetApp, context?: Context): Promise<void>;
|
|
@@ -4693,6 +4559,14 @@ declare type DestroyedEvent = BaseEvent_4 & {
|
|
|
4693
4559
|
type: 'destroyed';
|
|
4694
4560
|
};
|
|
4695
4561
|
|
|
4562
|
+
/**
|
|
4563
|
+
* @interface
|
|
4564
|
+
*/
|
|
4565
|
+
declare type DeviceInfo = {
|
|
4566
|
+
vendorId: string | number;
|
|
4567
|
+
productId: string | number;
|
|
4568
|
+
};
|
|
4569
|
+
|
|
4696
4570
|
/**
|
|
4697
4571
|
* Generated when a page's theme color changes. This is usually due to encountering a meta tag.
|
|
4698
4572
|
* @interface
|
|
@@ -4873,6 +4747,25 @@ declare type DisplayMetadata_3 = {
|
|
|
4873
4747
|
readonly glyph?: string;
|
|
4874
4748
|
};
|
|
4875
4749
|
|
|
4750
|
+
/**
|
|
4751
|
+
* @interface
|
|
4752
|
+
* 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.
|
|
4753
|
+
*/
|
|
4754
|
+
declare type DomainSettings = {
|
|
4755
|
+
rules: DomainSettingsRule[];
|
|
4756
|
+
};
|
|
4757
|
+
|
|
4758
|
+
/**
|
|
4759
|
+
* @interface
|
|
4760
|
+
*/
|
|
4761
|
+
declare type DomainSettingsRule = {
|
|
4762
|
+
match: string[];
|
|
4763
|
+
options: {
|
|
4764
|
+
downloadSettings?: FileDownloadSettings;
|
|
4765
|
+
api?: ApiInjection;
|
|
4766
|
+
};
|
|
4767
|
+
};
|
|
4768
|
+
|
|
4876
4769
|
/**
|
|
4877
4770
|
* Metadata returned from a preload script download request.
|
|
4878
4771
|
*
|
|
@@ -4917,14 +4810,24 @@ declare type DownloadRule = {
|
|
|
4917
4810
|
* @interface
|
|
4918
4811
|
*
|
|
4919
4812
|
* Controls the styling and behavior of the window download shelf.
|
|
4813
|
+
*
|
|
4814
|
+
* @remarks This will control the styling for the download shelf regardless of whether its display was
|
|
4815
|
+
* triggered by the window itself, or a view targeting the window.
|
|
4920
4816
|
*/
|
|
4921
4817
|
declare type DownloadShelfOptions = {
|
|
4922
4818
|
/**
|
|
4923
|
-
* Whether downloads in this window trigger
|
|
4819
|
+
* Whether downloads in this window trigger display of the download shelf.
|
|
4820
|
+
*
|
|
4821
|
+
* @remarks Setting this to false will *not* prevent the download shelf from opening if a child view
|
|
4822
|
+
* with `downloadShelf: { enabled: true }` initiates a download.
|
|
4924
4823
|
*/
|
|
4925
4824
|
enabled: boolean;
|
|
4926
4825
|
/**
|
|
4927
4826
|
* Styling options for the download shelf border.
|
|
4827
|
+
*
|
|
4828
|
+
* @remarks These apply regardless of whether download shelf display was
|
|
4829
|
+
* triggered by this window itself, or a view targeting the window. Individual views
|
|
4830
|
+
* cannot control the rendering of their parent window's download shelf.
|
|
4928
4831
|
*/
|
|
4929
4832
|
border?: {
|
|
4930
4833
|
/**
|
|
@@ -4934,7 +4837,7 @@ declare type DownloadShelfOptions = {
|
|
|
4934
4837
|
*/
|
|
4935
4838
|
size?: number;
|
|
4936
4839
|
/**
|
|
4937
|
-
* Color of the border
|
|
4840
|
+
* Color of the border. Must be a 6-character hex code prefixed by #. Defaults to chromium theme
|
|
4938
4841
|
* if absent.
|
|
4939
4842
|
*/
|
|
4940
4843
|
color?: string;
|
|
@@ -5158,9 +5061,10 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
|
|
|
5158
5061
|
} : never;
|
|
5159
5062
|
|
|
5160
5063
|
declare interface Environment {
|
|
5161
|
-
|
|
5064
|
+
initLayoutManager(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, wire: Transport, options: OpenFin_2.InitLayoutOptions): Promise<OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>>;
|
|
5162
5065
|
createLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, options: OpenFin_2.CreateLayoutOptions): Promise<void>;
|
|
5163
5066
|
destroyLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<void>;
|
|
5067
|
+
resolveLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<any>;
|
|
5164
5068
|
initPlatform(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, ...args: Parameters<OpenFin_2.Fin['Platform']['init']>): ReturnType<OpenFin_2.Fin['Platform']['init']>;
|
|
5165
5069
|
observeBounds(element: Element, onChange: (bounds: DOMRect) => Promise<void> | void): () => void;
|
|
5166
5070
|
writeToken(path: string, token: string): Promise<string>;
|
|
@@ -5210,7 +5114,7 @@ declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotApplie
|
|
|
5210
5114
|
* under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
|
5211
5115
|
* from which they propagate).
|
|
5212
5116
|
*/
|
|
5213
|
-
declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ViewEvents.PropagatedEvent<'system'
|
|
5117
|
+
declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
|
|
5214
5118
|
|
|
5215
5119
|
/**
|
|
5216
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 Channel}. Events are
|
|
@@ -5382,7 +5286,7 @@ declare type EventType_7 = Event_10['type'];
|
|
|
5382
5286
|
/**
|
|
5383
5287
|
* Union of possible `type` values for a {@link SystemEvent}.
|
|
5384
5288
|
*/
|
|
5385
|
-
declare type EventType_8 =
|
|
5289
|
+
declare type EventType_8 = Event_11['type'];
|
|
5386
5290
|
|
|
5387
5291
|
/**
|
|
5388
5292
|
* @internal
|
|
@@ -5435,83 +5339,6 @@ declare class ExternalApplication extends EmitterBase<OpenFin_2.ExternalApplicat
|
|
|
5435
5339
|
* @internal
|
|
5436
5340
|
*/
|
|
5437
5341
|
constructor(wire: Transport, identity: OpenFin_2.ApplicationIdentity);
|
|
5438
|
-
/**
|
|
5439
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
|
5440
|
-
* @param eventType - The type of the event.
|
|
5441
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
|
5442
|
-
* @param options - Option to support event timestamps.
|
|
5443
|
-
*
|
|
5444
|
-
* @function addListener
|
|
5445
|
-
* @memberof ExternalApplication
|
|
5446
|
-
* @instance
|
|
5447
|
-
* @tutorial ExternalApplication.EventEmitter
|
|
5448
|
-
*/
|
|
5449
|
-
/**
|
|
5450
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
|
5451
|
-
* @param eventType - The type of the event.
|
|
5452
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
|
5453
|
-
* @param options - Option to support event timestamps.
|
|
5454
|
-
*
|
|
5455
|
-
* @function on
|
|
5456
|
-
* @memberof ExternalApplication
|
|
5457
|
-
* @instance
|
|
5458
|
-
* @tutorial ExternalApplication.EventEmitter
|
|
5459
|
-
*/
|
|
5460
|
-
/**
|
|
5461
|
-
* 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.
|
|
5462
|
-
* @param eventType - The type of the event.
|
|
5463
|
-
* @param listener - The callback function.
|
|
5464
|
-
* @param options - Option to support event timestamps.
|
|
5465
|
-
*
|
|
5466
|
-
* @function once
|
|
5467
|
-
* @memberof ExternalApplication
|
|
5468
|
-
* @instance
|
|
5469
|
-
* @tutorial ExternalApplication.EventEmitter
|
|
5470
|
-
*/
|
|
5471
|
-
/**
|
|
5472
|
-
* Adds a listener to the beginning of the listeners array for the specified event.
|
|
5473
|
-
* @param eventType - The type of the event.
|
|
5474
|
-
* @param listener - The callback function.
|
|
5475
|
-
* @param options - Option to support event timestamps.
|
|
5476
|
-
*
|
|
5477
|
-
* @function prependListener
|
|
5478
|
-
* @memberof ExternalApplication
|
|
5479
|
-
* @instance
|
|
5480
|
-
* @tutorial ExternalApplication.EventEmitter
|
|
5481
|
-
*/
|
|
5482
|
-
/**
|
|
5483
|
-
* 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.
|
|
5484
|
-
* The listener is added to the beginning of the listeners array.
|
|
5485
|
-
* @param eventType - The type of the event.
|
|
5486
|
-
* @param listener - The callback function.
|
|
5487
|
-
* @param options - Option to support event timestamps.
|
|
5488
|
-
*
|
|
5489
|
-
* @function prependOnceListener
|
|
5490
|
-
* @memberof ExternalApplication
|
|
5491
|
-
* @instance
|
|
5492
|
-
* @tutorial ExternalApplication.EventEmitter
|
|
5493
|
-
*/
|
|
5494
|
-
/**
|
|
5495
|
-
* Remove a listener from the listener array for the specified event.
|
|
5496
|
-
* Caution: Calling this method changes the array indices in the listener array behind the listener.
|
|
5497
|
-
* @param eventType - The type of the event.
|
|
5498
|
-
* @param listener - The callback function.
|
|
5499
|
-
* @param options - Option to support event timestamps.
|
|
5500
|
-
*
|
|
5501
|
-
* @function removeListener
|
|
5502
|
-
* @memberof ExternalApplication
|
|
5503
|
-
* @instance
|
|
5504
|
-
* @tutorial ExternalApplication.EventEmitter
|
|
5505
|
-
*/
|
|
5506
|
-
/**
|
|
5507
|
-
* Removes all listeners, or those of the specified event.
|
|
5508
|
-
* @param eventType - The type of the event.
|
|
5509
|
-
*
|
|
5510
|
-
* @function removeAllListeners
|
|
5511
|
-
* @memberof ExternalApplication
|
|
5512
|
-
* @instance
|
|
5513
|
-
* @tutorial ExternalApplication.EventEmitter
|
|
5514
|
-
*/
|
|
5515
5342
|
/**
|
|
5516
5343
|
* Retrieves information about the external application.
|
|
5517
5344
|
*
|
|
@@ -5765,7 +5592,7 @@ declare type FileDownloadEvent = {
|
|
|
5765
5592
|
*
|
|
5766
5593
|
* @interface
|
|
5767
5594
|
*/
|
|
5768
|
-
declare type FileDownloadLocationChangedEvent =
|
|
5595
|
+
declare type FileDownloadLocationChangedEvent = BaseEvent_3 & {
|
|
5769
5596
|
type: 'file-download-location-changed';
|
|
5770
5597
|
};
|
|
5771
5598
|
|
|
@@ -5930,83 +5757,6 @@ declare class _Frame extends EmitterBase<OpenFin_2.FrameEvent> {
|
|
|
5930
5757
|
* @internal
|
|
5931
5758
|
*/
|
|
5932
5759
|
constructor(wire: Transport, identity: OpenFin_2.Identity);
|
|
5933
|
-
/**
|
|
5934
|
-
* Adds the listener function to the end of the listeners array for the specified event type.
|
|
5935
|
-
* @param eventType - The type of the event.
|
|
5936
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
|
5937
|
-
* @param options - Option to support event timestamps.
|
|
5938
|
-
*
|
|
5939
|
-
* @function addListener
|
|
5940
|
-
* @memberof Frame
|
|
5941
|
-
* @instance
|
|
5942
|
-
* @tutorial Frame.EventEmitter
|
|
5943
|
-
*/
|
|
5944
|
-
/**
|
|
5945
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
|
5946
|
-
* @param eventType - The type of the event.
|
|
5947
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
|
5948
|
-
* @param options - Option to support event timestamps.
|
|
5949
|
-
*
|
|
5950
|
-
* @function on
|
|
5951
|
-
* @memberof Frame
|
|
5952
|
-
* @instance
|
|
5953
|
-
* @tutorial Frame.EventEmitter
|
|
5954
|
-
*/
|
|
5955
|
-
/**
|
|
5956
|
-
* 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.
|
|
5957
|
-
* @param eventType - The type of the event.
|
|
5958
|
-
* @param listener - The callback function.
|
|
5959
|
-
* @param options - Option to support event timestamps.
|
|
5960
|
-
*
|
|
5961
|
-
* @function once
|
|
5962
|
-
* @memberof Frame
|
|
5963
|
-
* @instance
|
|
5964
|
-
* @tutorial Frame.EventEmitter
|
|
5965
|
-
*/
|
|
5966
|
-
/**
|
|
5967
|
-
* Adds a listener to the beginning of the listeners array for the specified event.
|
|
5968
|
-
* @param eventType - The type of the event.
|
|
5969
|
-
* @param listener - The callback function.
|
|
5970
|
-
* @param options - Option to support event timestamps.
|
|
5971
|
-
*
|
|
5972
|
-
* @function prependListener
|
|
5973
|
-
* @memberof Frame
|
|
5974
|
-
* @instance
|
|
5975
|
-
* @tutorial Frame.EventEmitter
|
|
5976
|
-
*/
|
|
5977
|
-
/**
|
|
5978
|
-
* 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.
|
|
5979
|
-
* The listener is added to the beginning of the listeners array.
|
|
5980
|
-
* @param eventType - The type of the event.
|
|
5981
|
-
* @param listener - The callback function.
|
|
5982
|
-
* @param options - Option to support event timestamps.
|
|
5983
|
-
*
|
|
5984
|
-
* @function prependOnceListener
|
|
5985
|
-
* @memberof Frame
|
|
5986
|
-
* @instance
|
|
5987
|
-
* @tutorial Frame.EventEmitter
|
|
5988
|
-
*/
|
|
5989
|
-
/**
|
|
5990
|
-
* Remove a listener from the listener array for the specified event.
|
|
5991
|
-
* Caution: Calling this method changes the array indices in the listener array behind the listener.
|
|
5992
|
-
* @param eventType - The type of the event.
|
|
5993
|
-
* @param listener - The callback function.
|
|
5994
|
-
* @param options - Option to support event timestamps.
|
|
5995
|
-
*
|
|
5996
|
-
* @function removeListener
|
|
5997
|
-
* @memberof Frame
|
|
5998
|
-
* @instance
|
|
5999
|
-
* @tutorial Frame.EventEmitter
|
|
6000
|
-
*/
|
|
6001
|
-
/**
|
|
6002
|
-
* Removes all listeners, or those of the specified event.
|
|
6003
|
-
* @param eventType - The type of the event.
|
|
6004
|
-
*
|
|
6005
|
-
* @function removeAllListeners
|
|
6006
|
-
* @memberof Frame
|
|
6007
|
-
* @instance
|
|
6008
|
-
* @tutorial Frame.EventEmitter
|
|
6009
|
-
*/
|
|
6010
5760
|
/**
|
|
6011
5761
|
* Returns a frame info object for the represented frame.
|
|
6012
5762
|
*
|
|
@@ -6781,6 +6531,11 @@ declare type IdentityEvent = BaseEvent & {
|
|
|
6781
6531
|
*/
|
|
6782
6532
|
declare type IdEventType = WithId<AppVersionEventType>;
|
|
6783
6533
|
|
|
6534
|
+
/**
|
|
6535
|
+
* @deprecated Renamed to {@link IdleStateChangedEvent}.
|
|
6536
|
+
*/
|
|
6537
|
+
declare type IdleEvent = IdleStateChangedEvent;
|
|
6538
|
+
|
|
6784
6539
|
/**
|
|
6785
6540
|
* Generated when a user enters or returns from idle state.
|
|
6786
6541
|
* @remarks This method is continuously generated every minute while the user is in idle.
|
|
@@ -6788,7 +6543,7 @@ declare type IdEventType = WithId<AppVersionEventType>;
|
|
|
6788
6543
|
* A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
|
|
6789
6544
|
* @interface
|
|
6790
6545
|
*/
|
|
6791
|
-
declare type
|
|
6546
|
+
declare type IdleStateChangedEvent = BaseEvent_8 & {
|
|
6792
6547
|
type: 'idle-state-changed';
|
|
6793
6548
|
elapsedTime: number;
|
|
6794
6549
|
isIdle: boolean;
|
|
@@ -6926,6 +6681,13 @@ declare type InitPlatformOptions = {
|
|
|
6926
6681
|
interopOverride?: OverrideCallback<InteropBroker> | ConstructorOverride<InteropBroker>[];
|
|
6927
6682
|
};
|
|
6928
6683
|
|
|
6684
|
+
/**
|
|
6685
|
+
* * 'none': The `fin` API will be not available from within this context.
|
|
6686
|
+
* * 'global': The entire `fin` API will be available from within this context.
|
|
6687
|
+
* @defaultValue 'global'
|
|
6688
|
+
*/
|
|
6689
|
+
declare type InjectionType = 'none' | 'global';
|
|
6690
|
+
|
|
6929
6691
|
/**
|
|
6930
6692
|
* Generated when the value of the element changes.
|
|
6931
6693
|
* @interface
|
|
@@ -7285,56 +7047,6 @@ declare class InteropBroker extends Base {
|
|
|
7285
7047
|
static createClosedConstructor(...args: ConstructorParameters<typeof InteropBroker>): {
|
|
7286
7048
|
new (): InteropBroker;
|
|
7287
7049
|
};
|
|
7288
|
-
/**
|
|
7289
|
-
* @REMOVED
|
|
7290
|
-
* SetContextOptions interface
|
|
7291
|
-
* @typedef { object } SetContextOptions@typedef { object } SetContextOptions
|
|
7292
|
-
* @property { Context } {context} - New context to set.
|
|
7293
|
-
*/
|
|
7294
|
-
/**
|
|
7295
|
-
* @REMOVED
|
|
7296
|
-
* GetContextOptions interface
|
|
7297
|
-
* @typedef { object } GetContextOptions@typedef { object } GetContextOptions
|
|
7298
|
-
* @property { string } [contextType] - Context Type
|
|
7299
|
-
*/
|
|
7300
|
-
/**
|
|
7301
|
-
* @REMOVED
|
|
7302
|
-
* JoinContextGroupOptions interface
|
|
7303
|
-
* @typedef { object } JoinContextGroupOptions@typedef { object } JoinContextGroupOptions
|
|
7304
|
-
* @property { string } contextGroupId - Id of the context group.
|
|
7305
|
-
* @property { Identity | ClientIdentity } [target] - Identity of the entity you wish to join to a context group.
|
|
7306
|
-
*/
|
|
7307
|
-
/**
|
|
7308
|
-
* @REMOVED
|
|
7309
|
-
* AddClientToContextGroupOptions interface
|
|
7310
|
-
* @typedef { object } AddClientToContextGroupOptions@typedef { object } AddClientToContextGroupOptions
|
|
7311
|
-
* @property { string } contextGroupId - Name of the context group.
|
|
7312
|
-
*/
|
|
7313
|
-
/**
|
|
7314
|
-
* @REMOVED
|
|
7315
|
-
* RemoveFromContextGroupOptions interface
|
|
7316
|
-
* @typedef { object } RemoveFromContextGroupOptions@typedef { object } RemoveFromContextGroupOptions
|
|
7317
|
-
* @property { Identity | ClientIdentity } target - Identity of the entity you wish to join to a context group.
|
|
7318
|
-
*/
|
|
7319
|
-
/**
|
|
7320
|
-
* @REMOVED
|
|
7321
|
-
* GetInfoForContextGroupOptions interface
|
|
7322
|
-
* @typedef { object } GetInfoForContextGroupOptions@typedef { object } GetInfoForContextGroupOptions
|
|
7323
|
-
* @property { string } contextGroupId - Name of the context group to get info for.
|
|
7324
|
-
*/
|
|
7325
|
-
/**
|
|
7326
|
-
* @REMOVED
|
|
7327
|
-
* GetAllClientsInContextGroupOptions interface
|
|
7328
|
-
* @typedef { object } GetAllClientsInContextGroupOptions@typedef { object } GetAllClientsInContextGroupOptions
|
|
7329
|
-
* @property { string } contextGroupId - Name of the context group to get info for.
|
|
7330
|
-
*/
|
|
7331
|
-
/**
|
|
7332
|
-
* @PORTED
|
|
7333
|
-
* InfoForIntentOptions interface
|
|
7334
|
-
* @typedef { object } InfoForIntentOptions@typedef { object } InfoForIntentOptions
|
|
7335
|
-
* @property { string } name Name of the intent to get info for.
|
|
7336
|
-
* @property { Context } [context] Optional context.
|
|
7337
|
-
*/
|
|
7338
7050
|
/**
|
|
7339
7051
|
* Sets a context for the context group of the incoming current entity.
|
|
7340
7052
|
* @param setContextOptions - New context to set.
|
|
@@ -7578,7 +7290,7 @@ declare class InteropBroker extends Base {
|
|
|
7578
7290
|
* // }
|
|
7579
7291
|
* ```
|
|
7580
7292
|
*
|
|
7581
|
-
* More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/
|
|
7293
|
+
* More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/Metadata#intentresolution).
|
|
7582
7294
|
*
|
|
7583
7295
|
* @param contextForIntent Data passed between entities and applications.
|
|
7584
7296
|
* @param clientIdentity Identity of the Client making the request.
|
|
@@ -7835,97 +7547,6 @@ declare type InteropBrokerOptions = {
|
|
|
7835
7547
|
};
|
|
7836
7548
|
|
|
7837
7549
|
/**
|
|
7838
|
-
* @PORTED
|
|
7839
|
-
* @typedef { object } Intent
|
|
7840
|
-
* @summary The combination of an action and a context that is passed to an application for resolution.
|
|
7841
|
-
* @property { string } name Name of the intent.
|
|
7842
|
-
* @property { Context } context Data associated with the intent
|
|
7843
|
-
*/
|
|
7844
|
-
/**
|
|
7845
|
-
* @REMOVED
|
|
7846
|
-
* @typedef { object } Subscription
|
|
7847
|
-
* @summary Object returned when subscribing a handler.
|
|
7848
|
-
* @property { function } unsubscribe Function to unsubscribe the handler.
|
|
7849
|
-
*/
|
|
7850
|
-
/**
|
|
7851
|
-
* @typedef { function } ContextHandler
|
|
7852
|
-
* @summary Subscription function for addContextHandler.
|
|
7853
|
-
*/
|
|
7854
|
-
/**
|
|
7855
|
-
* @typedef { function } IntentHandler
|
|
7856
|
-
* @summary Subscription function for registerIntentHandler
|
|
7857
|
-
*/
|
|
7858
|
-
/**
|
|
7859
|
-
* @PORTED
|
|
7860
|
-
* @typedef { object } ClientIdentity
|
|
7861
|
-
* @summary The Identity for a Channel Client. Includes endpointId to differentiate between different connections for an entity.
|
|
7862
|
-
* @property {string} uuid GUID of an application.
|
|
7863
|
-
* @property {string} name Name of an entity in an application.
|
|
7864
|
-
* @property {string} endpointId Unique differentiator for different Channel connections for an entity.
|
|
7865
|
-
*/
|
|
7866
|
-
/**
|
|
7867
|
-
* @PORTED
|
|
7868
|
-
* @typedef { object } ContextGroupInfo
|
|
7869
|
-
* @summary Information for a Context Group. Contains metadata for displaying the group properly.
|
|
7870
|
-
* @property {string} id Name of the context group
|
|
7871
|
-
* @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.
|
|
7872
|
-
*/
|
|
7873
|
-
/**
|
|
7874
|
-
* @PORTED
|
|
7875
|
-
* @typedef { object } DisplayMetadata
|
|
7876
|
-
* @summary The display data for a Context Group.
|
|
7877
|
-
* @property {string} name A user-readable name for this context group, e.g: `"Red"`
|
|
7878
|
-
* @property {string} [color] The color that should be associated within this context group when displaying this context group in a UI, e.g: `0xFF0000`.
|
|
7879
|
-
* @property {string} [glyph] A URL of an image that can be used to display this context group
|
|
7880
|
-
*/
|
|
7881
|
-
/**
|
|
7882
|
-
* @PORTED
|
|
7883
|
-
* @typedef { object } Context
|
|
7884
|
-
* @summary Data passed between entities and applications.
|
|
7885
|
-
* @property {object} [id] An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
|
|
7886
|
-
* @property {string} [name] User-readable name for the incoming context.
|
|
7887
|
-
* @property {string} type Conserved type for the context (e.g. `instrument` or `country`)
|
|
7888
|
-
*/
|
|
7889
|
-
/**
|
|
7890
|
-
* @REMOVED
|
|
7891
|
-
* @typedef { object } ContextForIntent
|
|
7892
|
-
* @summary Data passed between entities and applications, including an optional metadata.
|
|
7893
|
-
* @property {object} [id] An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
|
|
7894
|
-
* @property {string} [name] User-readable name for the incoming context.
|
|
7895
|
-
* @property {string} type Conserved type for the context (e.g. `instrument` or `country`)
|
|
7896
|
-
* @property {any} [metadata]
|
|
7897
|
-
*/
|
|
7898
|
-
/**
|
|
7899
|
-
* @REMOVED
|
|
7900
|
-
* @typedef { object } SessionContextGroup
|
|
7901
|
-
* @summary An instance of a SessionContextGroup
|
|
7902
|
-
* @property {string} id The SessionContextGroup's id.
|
|
7903
|
-
* @property {setContext} setContext Sets a context of a certain type
|
|
7904
|
-
* @property {getCurrentContext} getCurrentContext Gets the currently set context of a certain type
|
|
7905
|
-
* @property {addContextHandler} addContextHandler Adds a handler for context change.
|
|
7906
|
-
*/
|
|
7907
|
-
/**
|
|
7908
|
-
* @typedef {function} setContext
|
|
7909
|
-
* @summary A SessionContextGroup instance method for setting a context in the SessionContextGroup.
|
|
7910
|
-
* @param context The Context to be set.
|
|
7911
|
-
*
|
|
7912
|
-
*/
|
|
7913
|
-
/**
|
|
7914
|
-
* @typedef {function} getCurrentContext
|
|
7915
|
-
* @summary A SessionContextGroup instance method for getting the current context of a certain type.
|
|
7916
|
-
* @param contextType The Context Type to get. If not specified the last contextType set would get used.
|
|
7917
|
-
*
|
|
7918
|
-
*/
|
|
7919
|
-
/**
|
|
7920
|
-
* @typedef {function} addContextHandler
|
|
7921
|
-
* @summary A SessionContextGroup instance method for adding a handler for context change.
|
|
7922
|
-
* @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.
|
|
7923
|
-
* @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.
|
|
7924
|
-
*
|
|
7925
|
-
*/
|
|
7926
|
-
/**
|
|
7927
|
-
* {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}
|
|
7928
|
-
*
|
|
7929
7550
|
* The Interop Client API is broken up into two groups:
|
|
7930
7551
|
*
|
|
7931
7552
|
* **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.
|
|
@@ -8331,6 +7952,11 @@ declare class InteropClient extends Base {
|
|
|
8331
7952
|
* ```
|
|
8332
7953
|
*/
|
|
8333
7954
|
onDisconnection(listener: OpenFin_2.InteropClientOnDisconnectionListener): Promise<void>;
|
|
7955
|
+
/**
|
|
7956
|
+
* @internal
|
|
7957
|
+
*
|
|
7958
|
+
* Used to ferry fdc3-only calls from the fdc3 shim to the Interop Broker
|
|
7959
|
+
*/
|
|
8334
7960
|
static ferryFdc3Call(interopClient: OpenFin_2.InteropClient, action: string, payload?: any): Promise<any>;
|
|
8335
7961
|
}
|
|
8336
7962
|
|
|
@@ -8361,13 +7987,6 @@ declare type InteropLoggingActions = 'beforeAction' | 'afterAction';
|
|
|
8361
7987
|
*/
|
|
8362
7988
|
declare type InteropLoggingOptions = Record<InteropLoggingActions, InteropActionLoggingOption>;
|
|
8363
7989
|
|
|
8364
|
-
/**
|
|
8365
|
-
* @PORTED
|
|
8366
|
-
* @typedef { object } InteropConfig
|
|
8367
|
-
* @summary Information relevant to the Interop Broker.
|
|
8368
|
-
* @property {string} [currentContextGroup] Context Group for the client. (green, yellow, red, etc.)
|
|
8369
|
-
* @property {string} [providerId] When provided, automatically connects the client to the specified provider uuid
|
|
8370
|
-
*/
|
|
8371
7990
|
/**
|
|
8372
7991
|
* Manages creation of Interop Brokers and Interop Clients. These APIs are called under-the-hood in Platforms.
|
|
8373
7992
|
*
|
|
@@ -8758,7 +8377,7 @@ declare class Layout extends Base {
|
|
|
8758
8377
|
* @internal
|
|
8759
8378
|
*/
|
|
8760
8379
|
init: (options?: OpenFin_2.InitLayoutOptions) => Promise<Layout>;
|
|
8761
|
-
identity: OpenFin_2.LayoutIdentity;
|
|
8380
|
+
identity: OpenFin_2.Identity | OpenFin_2.LayoutIdentity;
|
|
8762
8381
|
private platform;
|
|
8763
8382
|
wire: Transport;
|
|
8764
8383
|
/**
|
|
@@ -8977,45 +8596,24 @@ declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'r
|
|
|
8977
8596
|
*/
|
|
8978
8597
|
declare type LayoutIdentity = Identity_5 & {
|
|
8979
8598
|
/**
|
|
8980
|
-
* The name of the layout
|
|
8981
|
-
* OpenFin attempts to resolve the instance via visibility checks.
|
|
8599
|
+
* The name of the layout in a given window.
|
|
8982
8600
|
*/
|
|
8983
|
-
layoutName
|
|
8601
|
+
layoutName: string;
|
|
8984
8602
|
};
|
|
8985
8603
|
|
|
8986
8604
|
/**
|
|
8987
|
-
* Generated when
|
|
8605
|
+
* Generated when the window is created, and all of its layout's views have either finished or failed
|
|
8606
|
+
* navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
|
|
8988
8607
|
* @interface
|
|
8989
8608
|
*/
|
|
8990
8609
|
declare type LayoutInitializedEvent = BaseEvent_5 & {
|
|
8991
8610
|
type: 'layout-initialized';
|
|
8611
|
+
layoutIdentity: OpenFin_2.LayoutIdentity;
|
|
8992
8612
|
ofViews: (OpenFin_2.Identity & {
|
|
8993
8613
|
entityType: 'view';
|
|
8994
8614
|
})[];
|
|
8995
8615
|
};
|
|
8996
8616
|
|
|
8997
|
-
/**
|
|
8998
|
-
* @interface @experimental @internal
|
|
8999
|
-
*
|
|
9000
|
-
* **NOTE**: Internal use only. This type is reserved for Workspace Browser implementation.
|
|
9001
|
-
*
|
|
9002
|
-
* Responsible for handling all layout management and renderering
|
|
9003
|
-
*/
|
|
9004
|
-
declare type LayoutInstance = {
|
|
9005
|
-
identity: LayoutIdentity;
|
|
9006
|
-
getFrameSnapshot: () => Promise<LayoutOptions>;
|
|
9007
|
-
addView: (payload: AddViewOptions) => Promise<View_2>;
|
|
9008
|
-
closeView: (viewIdentity: Identity_5) => Promise<void>;
|
|
9009
|
-
removeView: (viewConfig: Identity_5 | ViewState) => Promise<View_2>;
|
|
9010
|
-
replaceView: (payload: ReplaceViewOptions) => Promise<View_2>;
|
|
9011
|
-
getViews: () => LayoutComponent[];
|
|
9012
|
-
getCurrentViews: () => Identity_5[];
|
|
9013
|
-
startReplaceLayout: (payload: ReplaceLayoutOptions) => Promise<void>;
|
|
9014
|
-
applyPreset: (payload: PresetLayoutOptions_2) => void;
|
|
9015
|
-
isVisible: () => boolean;
|
|
9016
|
-
destroy: () => Promise<void>;
|
|
9017
|
-
};
|
|
9018
|
-
|
|
9019
8617
|
/**
|
|
9020
8618
|
* Represents the arrangement of Views within a Platform window's Layout. We do not recommend trying
|
|
9021
8619
|
* to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot}.
|
|
@@ -9043,7 +8641,7 @@ declare type LayoutItemConfig = {
|
|
|
9043
8641
|
*
|
|
9044
8642
|
* **NOTE**: Internal use only. This type is reserved for Workspace Browser implementation.
|
|
9045
8643
|
*
|
|
9046
|
-
* Responsible for
|
|
8644
|
+
* Responsible for aggregating all layout snapshots and storing layout instances
|
|
9047
8645
|
*/
|
|
9048
8646
|
declare interface LayoutManager<T extends LayoutSnapshot> {
|
|
9049
8647
|
/**
|
|
@@ -9067,16 +8665,6 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
|
|
|
9067
8665
|
* @throws if Object.keys(snapshot).length > 1
|
|
9068
8666
|
*/
|
|
9069
8667
|
applyLayoutSnapshot(snapshot: T): Promise<void>;
|
|
9070
|
-
/**
|
|
9071
|
-
* Called at the start of layout initialization. Adds a new LayoutInstance if the snapshot
|
|
9072
|
-
* contains a single layout.
|
|
9073
|
-
*
|
|
9074
|
-
* Throws if the snapshot contains more than 1 layout, it is expected that the user handles calling
|
|
9075
|
-
* fin.Platform.Layout.create() once for each layout to properly connect it to their UI state.
|
|
9076
|
-
*
|
|
9077
|
-
* @param snapshot
|
|
9078
|
-
* @throws if Object.keys(snapshot).length > 1
|
|
9079
|
-
*/
|
|
9080
8668
|
/**
|
|
9081
8669
|
* @experimental
|
|
9082
8670
|
*
|
|
@@ -9097,31 +8685,49 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
|
|
|
9097
8685
|
/**
|
|
9098
8686
|
* @experimental
|
|
9099
8687
|
*
|
|
9100
|
-
*
|
|
9101
|
-
*
|
|
8688
|
+
* A hook provided to the consumer for controlling how OpenFin routes Layout API calls. Override
|
|
8689
|
+
* this method to control the target layout for Layout API calls.
|
|
8690
|
+
*
|
|
8691
|
+
* Example use case: You have hidden all the layouts and are showing a dialog that will
|
|
8692
|
+
* execute an API call (ex: Layout.replace()) - override this method and save the
|
|
8693
|
+
* "last visible" layout identity and return it.
|
|
8694
|
+
*
|
|
8695
|
+
* By default, OpenFin will use a series of checks to determine which Layout the API
|
|
8696
|
+
* call must route to in this order of precedence:
|
|
8697
|
+
* - try to resolve the layout from the layoutIdentity, throws if missing
|
|
8698
|
+
* - if there is only 1 layout, resolves that one
|
|
8699
|
+
* - enumerates all layouts checks visibility via element offsetTop/Left + window.innerHeight/Width
|
|
8700
|
+
* - returns undefined
|
|
8701
|
+
*
|
|
8702
|
+
* @param identity
|
|
8703
|
+
* @returns LayoutIdentity | undefined
|
|
9102
8704
|
*/
|
|
9103
|
-
|
|
8705
|
+
resolveLayoutIdentity(identity?: Identity_5 | LayoutIdentity): LayoutIdentity | undefined;
|
|
9104
8706
|
/**
|
|
9105
8707
|
* @experimental
|
|
9106
8708
|
*
|
|
9107
|
-
*
|
|
9108
|
-
*
|
|
9109
|
-
*
|
|
9110
|
-
*
|
|
8709
|
+
* A hook provided to the consumer when it's time to remove a layout. Use this hook to
|
|
8710
|
+
* update your local state and remove the layout for the given LayoutIdentity. Note that
|
|
8711
|
+
* this hook does not call `fin.Platform.Layout.destroy()` for you, instead it is to
|
|
8712
|
+
* signify to your application it's time to destroy this layout.
|
|
8713
|
+
*
|
|
8714
|
+
* 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.
|
|
8715
|
+
*
|
|
8716
|
+
* @param LayoutIdentity
|
|
9111
8717
|
*/
|
|
9112
|
-
|
|
8718
|
+
removeLayout({ layoutName }: LayoutIdentity): Promise<void>;
|
|
9113
8719
|
/**
|
|
9114
8720
|
* @experimental
|
|
9115
8721
|
*/
|
|
9116
|
-
|
|
8722
|
+
getLayoutIdentityForView(viewIdentity: Identity_5): LayoutIdentity;
|
|
9117
8723
|
/**
|
|
9118
8724
|
* @experimental
|
|
9119
8725
|
*/
|
|
9120
|
-
|
|
8726
|
+
isLayoutVisible({ layoutName }: LayoutIdentity): boolean;
|
|
9121
8727
|
/**
|
|
9122
8728
|
* @experimental
|
|
9123
8729
|
*/
|
|
9124
|
-
|
|
8730
|
+
size(): number;
|
|
9125
8731
|
}
|
|
9126
8732
|
|
|
9127
8733
|
/**
|
|
@@ -9168,7 +8774,7 @@ declare class LayoutModule extends Base {
|
|
|
9168
8774
|
* const layoutConfig = await layout.getConfig();
|
|
9169
8775
|
* ```
|
|
9170
8776
|
*/
|
|
9171
|
-
wrap(identity: OpenFin_2.LayoutIdentity): Promise<OpenFin_2.Layout>;
|
|
8777
|
+
wrap(identity: OpenFin_2.Identity | OpenFin_2.LayoutIdentity): Promise<OpenFin_2.Layout>;
|
|
9172
8778
|
/**
|
|
9173
8779
|
* Synchronously returns a Layout object that represents a Window's layout.
|
|
9174
8780
|
*
|
|
@@ -9188,7 +8794,7 @@ declare class LayoutModule extends Base {
|
|
|
9188
8794
|
* const layoutConfig = await layout.getConfig();
|
|
9189
8795
|
* ```
|
|
9190
8796
|
*/
|
|
9191
|
-
wrapSync(identity: OpenFin_2.LayoutIdentity): OpenFin_2.Layout;
|
|
8797
|
+
wrapSync(identity: OpenFin_2.Identity | OpenFin_2.LayoutIdentity): OpenFin_2.Layout;
|
|
9192
8798
|
/**
|
|
9193
8799
|
* Asynchronously returns a Layout object that represents a Window's layout.
|
|
9194
8800
|
*
|
|
@@ -9360,6 +8966,15 @@ declare abstract class LayoutNode {
|
|
|
9360
8966
|
/**
|
|
9361
8967
|
* Creates a new TabStack adjacent to the given TabStack or ColumnOrRow. Inputs can be new views to create, or existing views.
|
|
9362
8968
|
*
|
|
8969
|
+
* Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
|
|
8970
|
+
* during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
|
|
8971
|
+
* This means the views you pass to createAdjacentStack() may not render in the order given by the array.
|
|
8972
|
+
* Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
|
|
8973
|
+
*
|
|
8974
|
+
* @param views The views that will populate the new TabStack.
|
|
8975
|
+
* @param options Additional options that control new TabStack creation.
|
|
8976
|
+
* @returns The newly-created TabStack.
|
|
8977
|
+
*
|
|
9363
8978
|
* @example
|
|
9364
8979
|
* ```js
|
|
9365
8980
|
* if (!fin.me.isView) {
|
|
@@ -9394,12 +9009,15 @@ declare abstract class LayoutNode {
|
|
|
9394
9009
|
* console.log(`A new TabStack created to the right has ${newStack.length} views in it`);
|
|
9395
9010
|
*
|
|
9396
9011
|
* ```
|
|
9012
|
+
* @experimental
|
|
9397
9013
|
*/
|
|
9398
9014
|
createAdjacentStack: (views: OpenFin_2.PlatformViewCreationOptions[], options: {
|
|
9399
9015
|
position?: OpenFin_2.LayoutPosition;
|
|
9400
9016
|
}) => Promise<TabStack>;
|
|
9401
9017
|
/**
|
|
9402
|
-
* Retrieves the adjacent TabStacks of the given TabStack or ColumnOrRow
|
|
9018
|
+
* Retrieves the adjacent TabStacks of the given TabStack or ColumnOrRow.
|
|
9019
|
+
*
|
|
9020
|
+
* @param edge Edge whose adjacent TabStacks will be returned.
|
|
9403
9021
|
*
|
|
9404
9022
|
* @example
|
|
9405
9023
|
* ```js
|
|
@@ -9419,6 +9037,7 @@ declare abstract class LayoutNode {
|
|
|
9419
9037
|
* console.log(`The entity has ${rightStacks.length} stacks to the right, and ${leftStacks.length} stacks to the left`);
|
|
9420
9038
|
*
|
|
9421
9039
|
* ```
|
|
9040
|
+
* @experimental
|
|
9422
9041
|
*/
|
|
9423
9042
|
getAdjacentStacks: (edge: OpenFin_2.LayoutPosition) => Promise<TabStack[]>;
|
|
9424
9043
|
}
|
|
@@ -9442,7 +9061,7 @@ declare type LayoutOptions = {
|
|
|
9442
9061
|
* @defaultValue false
|
|
9443
9062
|
*
|
|
9444
9063
|
* Limits the area to which tabs can be dragged.
|
|
9445
|
-
* If true,
|
|
9064
|
+
* If true, the layout container is the only area where tabs can be dropped.
|
|
9446
9065
|
*/
|
|
9447
9066
|
constrainDragToContainer?: boolean;
|
|
9448
9067
|
/**
|
|
@@ -9513,19 +9132,23 @@ declare type LayoutOptions = {
|
|
|
9513
9132
|
};
|
|
9514
9133
|
};
|
|
9515
9134
|
|
|
9135
|
+
/**
|
|
9136
|
+
* Represents the position of an item in a layout relative to another.
|
|
9137
|
+
*/
|
|
9516
9138
|
declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
|
|
9517
9139
|
|
|
9518
9140
|
/**
|
|
9519
|
-
*
|
|
9141
|
+
* Layout preset type.
|
|
9520
9142
|
*/
|
|
9521
9143
|
declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
|
|
9522
9144
|
|
|
9523
9145
|
/**
|
|
9524
|
-
* Generated when
|
|
9146
|
+
* Generated when the layout and all of the its views have been created and can receive API calls.
|
|
9525
9147
|
* @interface
|
|
9526
9148
|
*/
|
|
9527
9149
|
declare type LayoutReadyEvent = BaseEvent_5 & {
|
|
9528
9150
|
type: 'layout-ready';
|
|
9151
|
+
layoutIdentity: OpenFin_2.LayoutIdentity;
|
|
9529
9152
|
views: (OpenFin_2.Identity & {
|
|
9530
9153
|
success: boolean;
|
|
9531
9154
|
})[];
|
|
@@ -9872,14 +9495,9 @@ declare type MonitorDetails = {
|
|
|
9872
9495
|
};
|
|
9873
9496
|
|
|
9874
9497
|
/**
|
|
9875
|
-
*
|
|
9876
|
-
* @remarks A monitor's size changes when the taskbar is resized or relocated.
|
|
9877
|
-
* The available space of a monitor defines a rectangle that is not occupied by the taskbar
|
|
9878
|
-
* @interface
|
|
9498
|
+
* @deprecated Renamed to {@link MonitorInfoChangedEvent}.
|
|
9879
9499
|
*/
|
|
9880
|
-
declare type MonitorEvent =
|
|
9881
|
-
type: 'monitor-info-changed';
|
|
9882
|
-
};
|
|
9500
|
+
declare type MonitorEvent = MonitorInfoChangedEvent;
|
|
9883
9501
|
|
|
9884
9502
|
/**
|
|
9885
9503
|
* @interface
|
|
@@ -9903,6 +9521,16 @@ declare type MonitorInfo = {
|
|
|
9903
9521
|
virtualScreen: DipRect;
|
|
9904
9522
|
};
|
|
9905
9523
|
|
|
9524
|
+
/**
|
|
9525
|
+
* Generated on changes of a monitor's size/location.
|
|
9526
|
+
* @remarks A monitor's size changes when the taskbar is resized or relocated.
|
|
9527
|
+
* The available space of a monitor defines a rectangle that is not occupied by the taskbar
|
|
9528
|
+
* @interface
|
|
9529
|
+
*/
|
|
9530
|
+
declare type MonitorInfoChangedEvent = BaseEvent_8 & OpenFin_2.MonitorInfo & {
|
|
9531
|
+
type: 'monitor-info-changed';
|
|
9532
|
+
};
|
|
9533
|
+
|
|
9906
9534
|
/**
|
|
9907
9535
|
* @interface
|
|
9908
9536
|
*/
|
|
@@ -10233,6 +9861,10 @@ declare type MutableWindowOptions = {
|
|
|
10233
9861
|
* Used by Workspace to store custom data. Overwriting or modifying this field may impact the functionality of Workspace
|
|
10234
9862
|
*/
|
|
10235
9863
|
_internalWorkspaceData: any;
|
|
9864
|
+
/**
|
|
9865
|
+
* @internal
|
|
9866
|
+
* Used by workspace to stork platform specific options. Overwriting or modifying this field may impact the functionality of Workspace
|
|
9867
|
+
*/
|
|
10236
9868
|
workspacePlatform: WorkspacePlatformOptions;
|
|
10237
9869
|
};
|
|
10238
9870
|
|
|
@@ -10319,7 +9951,7 @@ declare type NotCloseRequested<EventType extends string> = Exclude<EventType, 'c
|
|
|
10319
9951
|
*
|
|
10320
9952
|
* Ensures that an event type key doesn't include any `-requested` events. Distributes over unions.
|
|
10321
9953
|
*/
|
|
10322
|
-
declare type NotRequested<EventType extends String> = EventType extends `${
|
|
9954
|
+
declare type NotRequested<EventType extends String> = EventType extends `${string}-requested` ? never : EventType;
|
|
10323
9955
|
|
|
10324
9956
|
/**
|
|
10325
9957
|
* Generated when an application is not responding.
|
|
@@ -10431,6 +10063,7 @@ declare namespace OpenFin_2 {
|
|
|
10431
10063
|
ResizeRegion,
|
|
10432
10064
|
Accelerator,
|
|
10433
10065
|
Api,
|
|
10066
|
+
InjectionType,
|
|
10434
10067
|
NavigationRules,
|
|
10435
10068
|
ContentNavigation,
|
|
10436
10069
|
ContentRedirect,
|
|
@@ -10476,6 +10109,7 @@ declare namespace OpenFin_2 {
|
|
|
10476
10109
|
WebPermission,
|
|
10477
10110
|
VerboseWebPermission,
|
|
10478
10111
|
OpenExternalPermission,
|
|
10112
|
+
DeviceInfo,
|
|
10479
10113
|
Permissions_2 as Permissions,
|
|
10480
10114
|
PlatformWindowCreationOptions,
|
|
10481
10115
|
PlatformWindowOptions,
|
|
@@ -10577,6 +10211,9 @@ declare namespace OpenFin_2 {
|
|
|
10577
10211
|
RuntimeInfo,
|
|
10578
10212
|
DefaultDomainSettings,
|
|
10579
10213
|
DefaultDomainSettingsRule,
|
|
10214
|
+
DomainSettings,
|
|
10215
|
+
ApiInjection,
|
|
10216
|
+
DomainSettingsRule,
|
|
10580
10217
|
FileDownloadBehaviorNames,
|
|
10581
10218
|
FileDownloadSettings,
|
|
10582
10219
|
DownloadRule,
|
|
@@ -10633,7 +10270,6 @@ declare namespace OpenFin_2 {
|
|
|
10633
10270
|
InitLayoutOptions,
|
|
10634
10271
|
LayoutManagerConstructor,
|
|
10635
10272
|
LayoutManagerOverride,
|
|
10636
|
-
LayoutInstance,
|
|
10637
10273
|
LayoutManager,
|
|
10638
10274
|
CreateLayoutOptions,
|
|
10639
10275
|
PresetLayoutOptions_2 as PresetLayoutOptions,
|
|
@@ -10825,6 +10461,7 @@ declare type Permissions_2 = {
|
|
|
10825
10461
|
Application?: Partial<ApplicationPermissions>;
|
|
10826
10462
|
System?: Partial<SystemPermissions>;
|
|
10827
10463
|
webAPIs?: WebPermission[];
|
|
10464
|
+
devices?: DeviceInfo[];
|
|
10828
10465
|
};
|
|
10829
10466
|
|
|
10830
10467
|
declare type PermissionState_2 = 'granted' | 'denied' | 'unavailable';
|
|
@@ -11780,21 +11417,16 @@ declare interface PlatformProvider {
|
|
|
11780
11417
|
*/
|
|
11781
11418
|
getInitialLayoutSnapshot(payload: undefined, callerIdentity: OpenFin_2.Identity): Promise<OpenFin_2.LayoutSnapshot | undefined>;
|
|
11782
11419
|
/**
|
|
11783
|
-
* @experimental
|
|
11784
|
-
*
|
|
11785
|
-
* **NOTE**: Internal use only. This method is reserved for Workspace Browser implementation.
|
|
11786
|
-
*
|
|
11787
|
-
* Calls platform.createView for every view in the given layout. Returns an array of promises
|
|
11788
|
-
* one promise for each view create call
|
|
11420
|
+
* @experimental
|
|
11789
11421
|
*
|
|
11790
|
-
* @
|
|
11422
|
+
* This API is called during the {@link PlatformProvider.getSnapshot()} call.
|
|
11423
|
+
* Gets the current state of a particular window and its views and returns an object that
|
|
11424
|
+
* can be added to the {@link OpenFin.Snapshot.windows} property. Override this function if
|
|
11425
|
+
* you wish to mutate each window snapshot during the {@link PlatformProvider.getSnapshot()} call
|
|
11426
|
+
* @param identity
|
|
11791
11427
|
* @param callerIdentity
|
|
11792
|
-
* @returns an array of promises
|
|
11793
11428
|
*/
|
|
11794
|
-
|
|
11795
|
-
layout: GoldenLayout.Config;
|
|
11796
|
-
target?: OpenFin_2.Identity;
|
|
11797
|
-
}, callerIdentity: OpenFin_2.Identity): Promise<OpenFin_2.View>[];
|
|
11429
|
+
getWindowSnapshot(identity: OpenFin_2.Identity, callerIdentity: OpenFin_2.Identity): Promise<OpenFin_2.WindowCreationOptions>;
|
|
11798
11430
|
/**
|
|
11799
11431
|
* **NOTE**: Internal use only. It is not recommended to manage the state of individual views.
|
|
11800
11432
|
* Gets the current state of a single view and returns an object with the options needed to restore that view as part of a snapshot.
|
|
@@ -13258,7 +12890,7 @@ declare type ReplaceLayoutPayload = {
|
|
|
13258
12890
|
/**
|
|
13259
12891
|
* Identity of the window whose layout will be replaced.
|
|
13260
12892
|
*/
|
|
13261
|
-
target: LayoutIdentity;
|
|
12893
|
+
target: Identity_5 | LayoutIdentity;
|
|
13262
12894
|
};
|
|
13263
12895
|
|
|
13264
12896
|
/**
|
|
@@ -14095,83 +13727,6 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
14095
13727
|
*/
|
|
14096
13728
|
constructor(wire: Transport);
|
|
14097
13729
|
private sendExternalProcessRequest;
|
|
14098
|
-
/**
|
|
14099
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
|
14100
|
-
* @param eventType - The type of the event.
|
|
14101
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
|
14102
|
-
* @param options - Option to support event timestamps.
|
|
14103
|
-
*
|
|
14104
|
-
* @function addListener
|
|
14105
|
-
* @memberof System
|
|
14106
|
-
* @instance
|
|
14107
|
-
* @tutorial System.EventEmitter
|
|
14108
|
-
*/
|
|
14109
|
-
/**
|
|
14110
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
|
14111
|
-
* @param eventType - The type of the event.
|
|
14112
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
|
14113
|
-
* @param options - Option to support event timestamps.
|
|
14114
|
-
*
|
|
14115
|
-
* @function on
|
|
14116
|
-
* @memberof System
|
|
14117
|
-
* @instance
|
|
14118
|
-
* @tutorial System.EventEmitter
|
|
14119
|
-
*/
|
|
14120
|
-
/**
|
|
14121
|
-
* 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.
|
|
14122
|
-
* @param eventType - The type of the event.
|
|
14123
|
-
* @param listener - The callback function.
|
|
14124
|
-
* @param options - Option to support event timestamps.
|
|
14125
|
-
*
|
|
14126
|
-
* @function once
|
|
14127
|
-
* @memberof System
|
|
14128
|
-
* @instance
|
|
14129
|
-
* @tutorial System.EventEmitter
|
|
14130
|
-
*/
|
|
14131
|
-
/**
|
|
14132
|
-
* Adds a listener to the beginning of the listeners array for the specified event.
|
|
14133
|
-
* @param eventType - The type of the event.
|
|
14134
|
-
* @param listener - The callback function.
|
|
14135
|
-
* @param options - Option to support event timestamps.
|
|
14136
|
-
*
|
|
14137
|
-
* @function prependListener
|
|
14138
|
-
* @memberof System
|
|
14139
|
-
* @instance
|
|
14140
|
-
* @tutorial System.EventEmitter
|
|
14141
|
-
*/
|
|
14142
|
-
/**
|
|
14143
|
-
* 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.
|
|
14144
|
-
* The listener is added to the beginning of the listeners array.
|
|
14145
|
-
* @param eventType - The type of the event.
|
|
14146
|
-
* @param listener - The callback function.
|
|
14147
|
-
* @param options - Option to support event timestamps.
|
|
14148
|
-
*
|
|
14149
|
-
* @function prependOnceListener
|
|
14150
|
-
* @memberof System
|
|
14151
|
-
* @instance
|
|
14152
|
-
* @tutorial System.EventEmitter
|
|
14153
|
-
*/
|
|
14154
|
-
/**
|
|
14155
|
-
* Remove a listener from the listener array for the specified event.
|
|
14156
|
-
* Caution: Calling this method changes the array indices in the listener array behind the listener.
|
|
14157
|
-
* @param eventType - The type of the event.
|
|
14158
|
-
* @param listener - The callback function.
|
|
14159
|
-
* @param options - Option to support event timestamps.
|
|
14160
|
-
*
|
|
14161
|
-
* @function removeListener
|
|
14162
|
-
* @memberof System
|
|
14163
|
-
* @instance
|
|
14164
|
-
* @tutorial System.EventEmitter
|
|
14165
|
-
*/
|
|
14166
|
-
/**
|
|
14167
|
-
* Removes all listeners, or those of the specified event.
|
|
14168
|
-
* @param eventType - The type of the event.
|
|
14169
|
-
*
|
|
14170
|
-
* @function removeAllListeners
|
|
14171
|
-
* @memberof System
|
|
14172
|
-
* @instance
|
|
14173
|
-
* @tutorial System.EventEmitter
|
|
14174
|
-
*/
|
|
14175
13730
|
/**
|
|
14176
13731
|
* Returns the version of the runtime. The version contains the major, minor,
|
|
14177
13732
|
* build and revision numbers.
|
|
@@ -15615,7 +15170,9 @@ declare namespace SystemEvents {
|
|
|
15615
15170
|
NotRequested,
|
|
15616
15171
|
ExcludeRequested,
|
|
15617
15172
|
BaseEvent_8 as BaseEvent,
|
|
15173
|
+
IdleStateChangedEvent,
|
|
15618
15174
|
IdleEvent,
|
|
15175
|
+
MonitorInfoChangedEvent,
|
|
15619
15176
|
MonitorEvent,
|
|
15620
15177
|
SessionChangedEvent,
|
|
15621
15178
|
AppVersionEvent,
|
|
@@ -15759,75 +15316,11 @@ declare interface TabDragListener extends EventEmitter_2 {
|
|
|
15759
15316
|
contentItem: ContentItem;
|
|
15760
15317
|
}
|
|
15761
15318
|
|
|
15762
|
-
/**
|
|
15763
|
-
* @typedef {string} LayoutPosition
|
|
15764
|
-
* @summary Represents the position of an item in a layout relative to another. Possible values are 'top', 'bottom', 'left' and 'right'.
|
|
15765
|
-
*/
|
|
15766
|
-
/**
|
|
15767
|
-
* @typedef {object} StackCreationOptions
|
|
15768
|
-
* @summary Stack creation options.
|
|
15769
|
-
* @property {LayoutPosition} [position] - The position to create the new {@link TabStack} in, relative to the given adjacent {@link TabStack}. Defaults to 'right'.
|
|
15770
|
-
*/
|
|
15771
|
-
/**
|
|
15772
|
-
* @typedef {object} TabStack~AddViewOptions
|
|
15773
|
-
* @summary Options to use when adding a view to a {@link TabStack}
|
|
15774
|
-
* @property {number} [index] - Insertion index when adding the view. Defaults to 0.
|
|
15775
|
-
*/
|
|
15776
15319
|
/**
|
|
15777
15320
|
* A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
|
|
15778
15321
|
*/
|
|
15779
15322
|
declare class TabStack extends LayoutNode {
|
|
15780
15323
|
#private;
|
|
15781
|
-
/**
|
|
15782
|
-
* Determines if this {@link TabStack} is the top level content item in the current layout.
|
|
15783
|
-
* @function isRoot
|
|
15784
|
-
* @memberof TabStack
|
|
15785
|
-
* @instance
|
|
15786
|
-
* @tutorial TabStack.isRoot
|
|
15787
|
-
* @returns Resolves true if this TabStack is the top level content item, or false if it is not.
|
|
15788
|
-
*/
|
|
15789
|
-
/**
|
|
15790
|
-
* Determines if this {@link TabStack} exists.
|
|
15791
|
-
* @function exists
|
|
15792
|
-
* @instance
|
|
15793
|
-
* @memberof TabStack
|
|
15794
|
-
* @tutorial TabStack.exists
|
|
15795
|
-
* @returns Resolves true if this is the TabStack exists, or false if it has been destroyed.
|
|
15796
|
-
*/
|
|
15797
|
-
/**
|
|
15798
|
-
* Retrieves the parent {@link ColumnOrRow} of this {@link TabStack}, if one exists.
|
|
15799
|
-
* @function getParent
|
|
15800
|
-
* @instance
|
|
15801
|
-
* @memberof TabStack
|
|
15802
|
-
* @tutorial TabStack.getParent
|
|
15803
|
-
* @returns is the root content item or does not exist.
|
|
15804
|
-
*/
|
|
15805
|
-
/**
|
|
15806
|
-
* Returns all the adjacent stacks that share an edge with the given {@link TabStack}.
|
|
15807
|
-
* @function getAdjacentStacks
|
|
15808
|
-
* @instance
|
|
15809
|
-
* @memberof TabStack
|
|
15810
|
-
* @param {LayoutPosition} edge - Edge to check for any adjacent stacks.
|
|
15811
|
-
*
|
|
15812
|
-
* @tutorial TabStack.getAdjacentStacks
|
|
15813
|
-
*/
|
|
15814
|
-
/**
|
|
15815
|
-
* Given a list of view creation options or references and a layout position, creates a {@link TabStack} adjacent to the current {@link TabStack}
|
|
15816
|
-
*
|
|
15817
|
-
* Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
|
|
15818
|
-
* during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
|
|
15819
|
-
* This means the views you pass to createAdjacentStack() may not render in the order given by the array.
|
|
15820
|
-
* Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
|
|
15821
|
-
*
|
|
15822
|
-
* @function createAdjacentStack
|
|
15823
|
-
* @instance
|
|
15824
|
-
* @memberof TabStack
|
|
15825
|
-
* @param views - List of identities or view creation options of the views to include in the stack
|
|
15826
|
-
* @param options - Creation options.
|
|
15827
|
-
* @returns The created TabStack.
|
|
15828
|
-
* @tutorial TabStack.createAdjacentStack
|
|
15829
|
-
* @experimental
|
|
15830
|
-
*/
|
|
15831
15324
|
/** @internal */
|
|
15832
15325
|
constructor(client: LayoutEntitiesClient, entityId: string);
|
|
15833
15326
|
/**
|
|
@@ -16268,169 +15761,6 @@ declare type VerboseWebPermission = {
|
|
|
16268
15761
|
|
|
16269
15762
|
declare type View = OpenFin_2.View;
|
|
16270
15763
|
|
|
16271
|
-
/**
|
|
16272
|
-
* @PORTED
|
|
16273
|
-
* @typedef {object} View~options
|
|
16274
|
-
* @summary View creation options.
|
|
16275
|
-
* @desc This is the options object required by {@link View.create View.create}.
|
|
16276
|
-
*
|
|
16277
|
-
* Note that `name` and `target` are the only required properties — albeit the `url` property is usually provided as well
|
|
16278
|
-
* (defaults to `"about:blank"` when omitted).
|
|
16279
|
-
*
|
|
16280
|
-
* @property {object} [experimental]
|
|
16281
|
-
* Configurations for API injection.
|
|
16282
|
-
*
|
|
16283
|
-
* @property {boolean} [experimental.childWindows] Configure if the runtime should enable child windows for views.
|
|
16284
|
-
*
|
|
16285
|
-
* @property {object} [accelerator]
|
|
16286
|
-
* Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
|
|
16287
|
-
*
|
|
16288
|
-
* @property {boolean} [accelerator.devtools=false]
|
|
16289
|
-
* If `true`, enables the devtools keyboard shortcut:<br>
|
|
16290
|
-
* `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
|
|
16291
|
-
*
|
|
16292
|
-
* @property {boolean} [accelerator.reload=false]
|
|
16293
|
-
* If `true`, enables the reload keyboard shortcuts:<br>
|
|
16294
|
-
* `Ctrl` + `R` _(Windows)_<br>
|
|
16295
|
-
* `F5` _(Windows)_<br>
|
|
16296
|
-
* `Command` + `R` _(Mac)_
|
|
16297
|
-
*
|
|
16298
|
-
* @property {boolean} [accelerator.reloadIgnoringCache=false]
|
|
16299
|
-
* If `true`, enables the reload-from-source keyboard shortcuts:<br>
|
|
16300
|
-
* `Ctrl` + `Shift` + `R` _(Windows)_<br>
|
|
16301
|
-
* `Shift` + `F5` _(Windows)_<br>
|
|
16302
|
-
* `Command` + `Shift` + `R` _(Mac)_
|
|
16303
|
-
*
|
|
16304
|
-
* @property {boolean} [accelerator.zoom=false]
|
|
16305
|
-
* If `true`, enables the zoom keyboard shortcuts:<br>
|
|
16306
|
-
* `Ctrl` + `+` _(Zoom In)_<br>
|
|
16307
|
-
* `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
|
|
16308
|
-
* `Ctrl` + `NumPad+` _(Zoom In)_<br>
|
|
16309
|
-
* `Ctrl` + `-` _(Zoom Out)_<br>
|
|
16310
|
-
* `Ctrl` + `Shift` + `-` _(Zoom Out)_<br>
|
|
16311
|
-
* `Ctrl` + `NumPad-` _(Zoom Out)_<br>
|
|
16312
|
-
* `Ctrl` + `Scroll` _(Zoom In & Out)_<br>
|
|
16313
|
-
* `Ctrl` + `0` _(Restore to 100%)_
|
|
16314
|
-
*
|
|
16315
|
-
* @property {object} [api]
|
|
16316
|
-
* Configurations for API injection.
|
|
16317
|
-
*
|
|
16318
|
-
* @property {object} [api.iframe] Configure if the the API should be injected into iframes based on domain.
|
|
16319
|
-
*
|
|
16320
|
-
* @property {boolean} [api.iframe.crossOriginInjection=false] Controls if the `fin` API object is present for cross origin iframes.
|
|
16321
|
-
* @property {boolean} [api.iframe.sameOriginInjection=true] Controls if the `fin` API object is present for same origin iframes.
|
|
16322
|
-
*
|
|
16323
|
-
* @property {string} [autoplayPolicy="no-user-gesture-required"]
|
|
16324
|
-
* Autoplay policy to apply to content in the window, can be
|
|
16325
|
-
* `no-user-gesture-required`, `user-gesture-required`,
|
|
16326
|
-
* `document-user-activation-required`. Defaults to `no-user-gesture-required`.
|
|
16327
|
-
*
|
|
16328
|
-
* @property {object} [autoResize] AutoResize options
|
|
16329
|
-
*
|
|
16330
|
-
* @property {object} [bounds] initial bounds given relative to the window.
|
|
16331
|
-
*
|
|
16332
|
-
* @property {string} [backgroundColor="#FFF"] - _Updatable._
|
|
16333
|
-
* The view’s _backfill_ color as a hexadecimal value. Not to be confused with the content background color
|
|
16334
|
-
* (`document.body.style.backgroundColor`),
|
|
16335
|
-
* this color briefly fills a view’s (a) content area before its content is loaded as well as (b) newly exposed
|
|
16336
|
-
* areas when growing a window. Setting
|
|
16337
|
-
* this value to the anticipated content background color can help improve user experience.
|
|
16338
|
-
* Default is white.
|
|
16339
|
-
*
|
|
16340
|
-
* @property {object} [contentNavigation]
|
|
16341
|
-
* Restrict navigation to URLs that match an allowed pattern.
|
|
16342
|
-
* In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
|
|
16343
|
-
* See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
|
|
16344
|
-
* @property {string[]} [contentNavigation.allowlist=[]] List of allowed URLs.
|
|
16345
|
-
* @property {string[]} [contentNavigation.denylist=[]] List of denied URLs.
|
|
16346
|
-
*
|
|
16347
|
-
* @property {object} [contentRedirect]
|
|
16348
|
-
* Restrict redirects to URLs that match an allowed pattern.
|
|
16349
|
-
* In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
|
|
16350
|
-
* See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
|
|
16351
|
-
* @property {string[]} [contentRedirect.allowlist=[]] List of allowed URLs.
|
|
16352
|
-
* @property {string[]} [contentRedirect.denylist=[]] List of denied URLs.
|
|
16353
|
-
*
|
|
16354
|
-
* @property {object} [contextMenuSettings] - _Updatable._
|
|
16355
|
-
* Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
|
|
16356
|
-
* Configure the context menu when right-clicking on a view.
|
|
16357
|
-
* @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
|
|
16358
|
-
* @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
|
|
16359
|
-
* @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
|
|
16360
|
-
*
|
|
16361
|
-
* @property {object} [contextMenuOptions] - _Updatable._
|
|
16362
|
-
* Configure the context menu when right-clicking on a view. Supported menu items:
|
|
16363
|
-
* 'separator'
|
|
16364
|
-
* 'cut'
|
|
16365
|
-
* 'copy'
|
|
16366
|
-
* 'copyImage',
|
|
16367
|
-
* 'paste'
|
|
16368
|
-
* 'spellCheck'
|
|
16369
|
-
* 'inspect'
|
|
16370
|
-
* 'reload'
|
|
16371
|
-
* 'navigateForward'
|
|
16372
|
-
* 'navigateBack'
|
|
16373
|
-
* 'print'
|
|
16374
|
-
* @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
|
|
16375
|
-
* @property {string[]} [contextMenuOptions.template=[]] List of context menu items to display on right-click.
|
|
16376
|
-
*
|
|
16377
|
-
* @property {any} [customData=""] - _Updatable._
|
|
16378
|
-
* A field that the user can attach serializable data to be ferried around with the view options.
|
|
16379
|
-
* _When omitted, the default value of this property is the empty string (`""`)._
|
|
16380
|
-
*
|
|
16381
|
-
* @property {any} [customContext=""] - _Updatable._
|
|
16382
|
-
* A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
|
|
16383
|
-
* is called.
|
|
16384
|
-
* When omitted, the default value of this property is the empty string (`""`).
|
|
16385
|
-
* As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
|
|
16386
|
-
*
|
|
16387
|
-
* @property {object[]} [hotkeys=[]] - _Updatable._
|
|
16388
|
-
* Defines the list of hotkeys that will be emitted as a `hotkey` event on the view. For usage example see [example]{@tutorial hotkeys}.
|
|
16389
|
-
* Within Platform, OpenFin also implements a set of pre-defined actions called
|
|
16390
|
-
* [keyboard commands]{@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands}
|
|
16391
|
-
* that can be assigned to a specific hotkey in the platform manifest.
|
|
16392
|
-
* @property {string} hotkeys.keys The key combination of the hotkey, i.e. "Ctrl+T"
|
|
16393
|
-
* @property {boolean} [hotkeys.preventDefault=false] preventDefault will prevent the page keydown/keyup events from being emitted.
|
|
16394
|
-
*
|
|
16395
|
-
* @property {boolean} [isClosable=true] **Platforms Only.** If false, the view will be persistent and can't be closed through
|
|
16396
|
-
* either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
|
|
16397
|
-
* if the view isn't part of the new layout when running `Layout.replace`.
|
|
16398
|
-
*
|
|
16399
|
-
* @property {string} name
|
|
16400
|
-
* The name of the view.
|
|
16401
|
-
*
|
|
16402
|
-
* @property {boolean} [detachOnClose=false] - _Updatable._
|
|
16403
|
-
* Platforms Only. If true, will hide and detach the View from the window for later use instead of closing,
|
|
16404
|
-
* allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
|
|
16405
|
-
*
|
|
16406
|
-
* @property {string} [manifestUrl] **Platforms Only.** Url to a manifest that contains View Options. Properties other than manifestUrl can still be used
|
|
16407
|
-
* but the properties in the manifest will take precedence if there is any collision.
|
|
16408
|
-
*
|
|
16409
|
-
* @property {preloadScript[]} [preloadScripts] - _Inheritable_
|
|
16410
|
-
* A list of scripts that are eval'ed before other scripts in the page. When omitted, _inherits_
|
|
16411
|
-
* from the parent application.
|
|
16412
|
-
*
|
|
16413
|
-
* @property {boolean} [preventDragOut=false] **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
|
|
16414
|
-
*
|
|
16415
|
-
* @property {string} [processAffinity=<application uuid>]
|
|
16416
|
-
* A string to attempt to group renderers together. Will only be used if pages are on the same origin.
|
|
16417
|
-
*
|
|
16418
|
-
* @property {boolean} [spellCheck=false]
|
|
16419
|
-
* Enable spell check in input text fields for the view.
|
|
16420
|
-
*
|
|
16421
|
-
* @property {Identity} [target]
|
|
16422
|
-
* The identity of the window this view should be attached to.
|
|
16423
|
-
*
|
|
16424
|
-
* @property {string} [url="about:blank"]
|
|
16425
|
-
* The URL of the view.
|
|
16426
|
-
*
|
|
16427
|
-
* @property {string} [uuid=<application uuid>]
|
|
16428
|
-
* The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
|
|
16429
|
-
* If omitted, defaults to the `uuid` of the application spawning the view.
|
|
16430
|
-
* If given, must match the `uuid` of the application spawning the view.
|
|
16431
|
-
* In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
|
|
16432
|
-
* really no need to provide it.
|
|
16433
|
-
*/
|
|
16434
15764
|
/**
|
|
16435
15765
|
* A View can be used to embed additional web content into a Window.
|
|
16436
15766
|
* It is like a child window, except it is positioned relative to its owning window.
|
|
@@ -16946,7 +16276,7 @@ declare type ViewCreationOrReference = OpenFin_2.Identity | OpenFin_2.PlatformVi
|
|
|
16946
16276
|
*/
|
|
16947
16277
|
declare type ViewDetachedEvent = BaseEvent_5 & {
|
|
16948
16278
|
type: 'view-detached';
|
|
16949
|
-
target: OpenFin_2.Identity;
|
|
16279
|
+
target: OpenFin_2.Identity | null;
|
|
16950
16280
|
previousTarget: OpenFin_2.Identity;
|
|
16951
16281
|
viewIdentity: OpenFin_2.Identity;
|
|
16952
16282
|
};
|
|
@@ -18182,7 +17512,7 @@ declare namespace WebContentsEvents {
|
|
|
18182
17512
|
* `clipboard-read`: Request access to read from the clipboard.<br>
|
|
18183
17513
|
* `clipboard-sanitized-write`: Request access to write to the clipboard.
|
|
18184
17514
|
*/
|
|
18185
|
-
declare type WebPermission = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write' | OpenExternalPermission;
|
|
17515
|
+
declare type WebPermission = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write' | 'hid' | 'usb' | OpenExternalPermission;
|
|
18186
17516
|
|
|
18187
17517
|
/**
|
|
18188
17518
|
* Object representing headers and their values, where the
|
|
@@ -18260,476 +17590,6 @@ declare type WillResizeEvent = WillMoveOrResizeEvent & {
|
|
|
18260
17590
|
type: 'will-resize';
|
|
18261
17591
|
};
|
|
18262
17592
|
|
|
18263
|
-
/**
|
|
18264
|
-
* @PORTED
|
|
18265
|
-
* @typedef { object } Margins@typedef { object } Margins
|
|
18266
|
-
* @property { string } [marginType]
|
|
18267
|
-
* Can be `default`, `none`, `printableArea`, or `custom`. If `custom` is chosen,
|
|
18268
|
-
* you will also need to specify `top`, `bottom`, `left`, and `right`.
|
|
18269
|
-
*
|
|
18270
|
-
* @property { number } [top] The top margin of the printed web page, in pixels.
|
|
18271
|
-
* @property { number } [bottom] The bottom margin of the printed web page, in pixels.
|
|
18272
|
-
* @property { number } [left] The left margin of the printed web page, in pixels.
|
|
18273
|
-
* @property { number } [right] The right margin of the printed web page, in pixels.
|
|
18274
|
-
*/
|
|
18275
|
-
/**
|
|
18276
|
-
* @PORTED
|
|
18277
|
-
* @typedef { object } Dpi@typedef { object } Dpi
|
|
18278
|
-
* @property { number } [horizontal] The horizontal dpi
|
|
18279
|
-
* @property { number } [vertical] The vertical dpi
|
|
18280
|
-
*/
|
|
18281
|
-
/**
|
|
18282
|
-
* @PORTED
|
|
18283
|
-
* @typedef { object } PrintOptions@typedef { object } PrintOptions
|
|
18284
|
-
* @property { boolean } [silent=false] Don't ask user for print settings.
|
|
18285
|
-
* @property { boolean } [printBackground=false] Prints the background color and image of the web page.
|
|
18286
|
-
* @property { string } [deviceName=''] Set the printer device name to use.
|
|
18287
|
-
* @property { boolean } [color=true] Set whether the printed web page will be in color or grayscale.
|
|
18288
|
-
* @property { Margins } [margins] Set margins for the printed web page
|
|
18289
|
-
* @property { boolean } [landscape=false] Whether the web page should be printed in landscape mode.
|
|
18290
|
-
* @property { number } [scaleFactor] The scale factor of the web page.
|
|
18291
|
-
* @property { number } [pagesPerSheet] The number of pages to print per page sheet.
|
|
18292
|
-
* @property { boolean } [collate] Whether the web page should be collated.
|
|
18293
|
-
* @property { number } [copies] The number of copies of the web page to print.
|
|
18294
|
-
* @property { Record<string, number> } [pageRanges] The page range to print. Should have two keys: from and to.
|
|
18295
|
-
* @property { string } [duplexMode] Set the duplex mode of the printed web page. Can be simplex, shortEdge, or longEdge.
|
|
18296
|
-
* @property { Dpi } [dpi] Set dpi for the printed web page
|
|
18297
|
-
*/
|
|
18298
|
-
/**
|
|
18299
|
-
* @REMOVED
|
|
18300
|
-
* PrinterInfo interface
|
|
18301
|
-
* @typedef { object } PrinterInfo@typedef { object } PrinterInfo
|
|
18302
|
-
* @property { string } name Printer Name
|
|
18303
|
-
* @property { string } description Printer Description
|
|
18304
|
-
* @property { number } status Printer Status
|
|
18305
|
-
* @property { boolean } isDefault Indicates that system's default printer
|
|
18306
|
-
*/
|
|
18307
|
-
/**
|
|
18308
|
-
* @REMOVED
|
|
18309
|
-
* SharedWorkerInfo interface
|
|
18310
|
-
* @typedef { object } SharedWorkerInfo@typedef { object } SharedWorkerInfo
|
|
18311
|
-
* @property { string } id The unique id of the shared worker.
|
|
18312
|
-
* @property { string } url The url of the shared worker.
|
|
18313
|
-
*/
|
|
18314
|
-
/**
|
|
18315
|
-
* @PORTED
|
|
18316
|
-
* ContentCreationRule interface
|
|
18317
|
-
* @typedef { object } ContentCreationRule@typedef { object } ContentCreationRule
|
|
18318
|
-
* @property { string } behavior 'view' | 'window' | 'browser' | 'block'
|
|
18319
|
-
* @property { string[] } match List of [match patterns](https://developer.chrome.com/extensions/match_patterns).
|
|
18320
|
-
* @property { object } options Window creation options or View creation options.
|
|
18321
|
-
*/
|
|
18322
|
-
/**
|
|
18323
|
-
* @PORTED
|
|
18324
|
-
* @typedef {object} Window~options
|
|
18325
|
-
* @summary Window creation options.
|
|
18326
|
-
* @desc This is the options object required by {@link Window.create Window.create}.
|
|
18327
|
-
*
|
|
18328
|
-
* Note that `name` is the only required property — albeit the `url` property is usually provided as well
|
|
18329
|
-
* (defaults to `"about:blank"` when omitted).
|
|
18330
|
-
*
|
|
18331
|
-
* _This jsdoc typedef mirrors the `WindowOptions` TypeScript interface in `@types/openfin`._
|
|
18332
|
-
*
|
|
18333
|
-
* @property {object} [accelerator]
|
|
18334
|
-
* Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
|
|
18335
|
-
*
|
|
18336
|
-
* @property {boolean} [accelerator.devtools=false]
|
|
18337
|
-
* If `true`, enables the devtools keyboard shortcut:<br>
|
|
18338
|
-
* `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
|
|
18339
|
-
*
|
|
18340
|
-
* @property {boolean} [accelerator.reload=false]
|
|
18341
|
-
* If `true`, enables the reload keyboard shortcuts:<br>
|
|
18342
|
-
* `Ctrl` + `R` _(Windows)_<br>
|
|
18343
|
-
* `F5` _(Windows)_<br>
|
|
18344
|
-
* `Command` + `R` _(Mac)_
|
|
18345
|
-
*
|
|
18346
|
-
* @property {boolean} [accelerator.reloadIgnoringCache=false]
|
|
18347
|
-
* If `true`, enables the reload-from-source keyboard shortcuts:<br>
|
|
18348
|
-
* `Ctrl` + `Shift` + `R` _(Windows)_<br>
|
|
18349
|
-
* `Shift` + `F5` _(Windows)_<br>
|
|
18350
|
-
* `Command` + `Shift` + `R` _(Mac)_
|
|
18351
|
-
*
|
|
18352
|
-
* @property {boolean} [accelerator.zoom=false]
|
|
18353
|
-
* 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.
|
|
18354
|
-
* If `true`, enables the zoom keyboard shortcuts:<br>
|
|
18355
|
-
* `Ctrl` + `+` _(Zoom In)_<br>
|
|
18356
|
-
* `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
|
|
18357
|
-
* `Ctrl` + `NumPad+` _(Zoom In)_<br>
|
|
18358
|
-
* `Ctrl` + `-` _(Zoom Out)_<br>
|
|
18359
|
-
* `Ctrl` + `Shift` + `-` _(Zoom Out)_<br>
|
|
18360
|
-
* `Ctrl` + `NumPad-` _(Zoom Out)_<br>
|
|
18361
|
-
* `Ctrl` + `Scroll` _(Zoom In & Out)_<br>
|
|
18362
|
-
* `Ctrl` + `0` _(Restore to 100%)_
|
|
18363
|
-
*
|
|
18364
|
-
* @property {object} [alphaMask] - _Experimental._ _Updatable._
|
|
18365
|
-
* <br>
|
|
18366
|
-
* alphaMask turns anything of matching RGB value transparent.
|
|
18367
|
-
* <br>
|
|
18368
|
-
* Caveats:
|
|
18369
|
-
* * Runtime flags --disable-gpu and --allow-unsafe-compositing are required. Note: Unclear behavior on remote Desktop support
|
|
18370
|
-
* * User cannot click-through transparent regions
|
|
18371
|
-
* * Not supported on Mac
|
|
18372
|
-
* * Windows Aero must be enabled
|
|
18373
|
-
* * Won't make visual sense on Pixel-pushed environments such as Citrix
|
|
18374
|
-
* * Not supported on rounded corner windows
|
|
18375
|
-
* @property {number} [alphaMask.red=-1] 0-255
|
|
18376
|
-
* @property {number} [alphaMask.green=-1] 0-255
|
|
18377
|
-
* @property {number} [alphaMask.blue=-1] 0-255
|
|
18378
|
-
*
|
|
18379
|
-
* @property {boolean} [alwaysOnTop=false] - _Updatable._
|
|
18380
|
-
* A flag to always position the window at the top of the window stack.
|
|
18381
|
-
*
|
|
18382
|
-
* @property {object} [api]
|
|
18383
|
-
* Configurations for API injection.
|
|
18384
|
-
*
|
|
18385
|
-
* @property {object} [api.iframe] Configure if the the API should be injected into iframes based on domain.
|
|
18386
|
-
*
|
|
18387
|
-
* @property {boolean} [api.iframe.crossOriginInjection=false] Controls if the `fin` API object is present for cross origin iframes.
|
|
18388
|
-
* @property {boolean} [api.iframe.sameOriginInjection=true] Controls if the `fin` API object is present for same origin iframes.
|
|
18389
|
-
*
|
|
18390
|
-
* @property {string} [applicationIcon = ""] - _Deprecated_ - use `icon` instead.
|
|
18391
|
-
*
|
|
18392
|
-
* @property {number} [aspectRatio=0] - _Updatable._
|
|
18393
|
-
* The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
|
|
18394
|
-
* an aspect ratio will not be enforced.
|
|
18395
|
-
*
|
|
18396
|
-
* @property {string} [autoplayPolicy="no-user-gesture-required"]
|
|
18397
|
-
* Autoplay policy to apply to content in the window, can be
|
|
18398
|
-
* `no-user-gesture-required`, `user-gesture-required`,
|
|
18399
|
-
* `document-user-activation-required`. Defaults to `no-user-gesture-required`.
|
|
18400
|
-
*
|
|
18401
|
-
* @property {boolean} [autoShow=true]
|
|
18402
|
-
* A flag to automatically show the window when it is created.
|
|
18403
|
-
*
|
|
18404
|
-
* @property {string} [backgroundColor="#FFF"]
|
|
18405
|
-
* The window’s _backfill_ color as a hexadecimal value. Not to be confused with the content background color
|
|
18406
|
-
* (`document.body.style.backgroundColor`),
|
|
18407
|
-
* this color briefly fills a window’s (a) content area before its content is loaded as well as (b) newly exposed
|
|
18408
|
-
* areas when growing a window. Setting
|
|
18409
|
-
* this value to the anticipated content background color can help improve user experience.
|
|
18410
|
-
* Default is white.
|
|
18411
|
-
*
|
|
18412
|
-
* @property {object} [contentCreation]
|
|
18413
|
-
* Apply rules that determine how user interaction (`window.open` and links) creates content.
|
|
18414
|
-
* @property {ContentCreationRule[]} [contentCreation.rules = []] List of content creation rules.
|
|
18415
|
-
*
|
|
18416
|
-
* @property {object} [contentNavigation]
|
|
18417
|
-
* Restrict navigation to URLs that match an allowed pattern.
|
|
18418
|
-
* In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
|
|
18419
|
-
* See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
|
|
18420
|
-
* @property {string[]} [contentNavigation.allowlist=[]] List of allowed URLs.
|
|
18421
|
-
* @property {string[]} [contentNavigation.denylist=[]] List of denied URLs.
|
|
18422
|
-
*
|
|
18423
|
-
* @property {object} [contentRedirect]
|
|
18424
|
-
* Restrict redirects to URLs that match an allowed pattern.
|
|
18425
|
-
* In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
|
|
18426
|
-
* See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
|
|
18427
|
-
* @property {string[]} [contentRedirect.allowlist=[]] List of allowed URLs.
|
|
18428
|
-
* @property {string[]} [contentRedirect.denylist=[]] List of denied URLs.
|
|
18429
|
-
*
|
|
18430
|
-
* @property {boolean} [contextMenu=true] - _Updatable._
|
|
18431
|
-
* A flag to show the context menu when right-clicking on a window.
|
|
18432
|
-
* Gives access to the devtools for the window.
|
|
18433
|
-
*
|
|
18434
|
-
* @property {object} [contextMenuSettings] - _Updatable._
|
|
18435
|
-
* Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
|
|
18436
|
-
* Configure the context menu when right-clicking on a window.
|
|
18437
|
-
* @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
|
|
18438
|
-
* @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
|
|
18439
|
-
* @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
|
|
18440
|
-
*
|
|
18441
|
-
* @property {object} [contextMenuOptions] - _Updatable._
|
|
18442
|
-
* Configure the context menu when right-clicking on a window. Supported menu items:
|
|
18443
|
-
* 'separator'
|
|
18444
|
-
* 'cut'
|
|
18445
|
-
* 'copy'
|
|
18446
|
-
* 'paste'
|
|
18447
|
-
* 'spellCheck'
|
|
18448
|
-
* 'inspect'
|
|
18449
|
-
* 'reload'
|
|
18450
|
-
* 'navigateForward'
|
|
18451
|
-
* 'navigateBack'
|
|
18452
|
-
* 'print'
|
|
18453
|
-
* @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
|
|
18454
|
-
* @property {string[]} [contextMenuSettings.template=[]] List of context menu items to display on right-click.
|
|
18455
|
-
*
|
|
18456
|
-
* @property {object} [cornerRounding] - _Updatable._
|
|
18457
|
-
* Defines and applies rounded corners for a frameless window. **NOTE:** On macOS corner is not ellipse but circle rounded by the
|
|
18458
|
-
* average of _height_ and _width_.
|
|
18459
|
-
* @property {number} [cornerRounding.height=0] The height in pixels.
|
|
18460
|
-
* @property {number} [cornerRounding.width=0] The width in pixels.
|
|
18461
|
-
*
|
|
18462
|
-
* @property {any} [customContext=""] - _Updatable. Inheritable._
|
|
18463
|
-
* A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
|
|
18464
|
-
* is called. If a window in a Platform is trying to update or retrieve its own context, it can use the
|
|
18465
|
-
* {@link Platform#setWindowContext Platform.setWindowContext} and {@link Platform#getWindowContext Platform.getWindowContext} calls.
|
|
18466
|
-
* _When omitted, _inherits_ from the parent application._
|
|
18467
|
-
* As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
|
|
18468
|
-
*
|
|
18469
|
-
* @property {any} [customData=""] - _Updatable. Inheritable._
|
|
18470
|
-
* A field that the user can attach serializable data to be ferried around with the window options.
|
|
18471
|
-
* _When omitted, _inherits_ from the parent application._
|
|
18472
|
-
*
|
|
18473
|
-
* @property {object[]} [customRequestHeaders]
|
|
18474
|
-
* Defines list of custom headers for requests sent by the window.
|
|
18475
|
-
* @property {string[]} [customRequestHeaders.urlPatterns=[]] The URL patterns for which the headers will be applied
|
|
18476
|
-
* @property {object[]} [customRequestHeaders.headers=[]] Objects representing headers and their values,
|
|
18477
|
-
* where the object key is the name of header and value at key is the value of the header
|
|
18478
|
-
*
|
|
18479
|
-
* @property {boolean} [closeOnLastViewRemoved=true] - _Experimental._ _Updatable._
|
|
18480
|
-
* Toggling off would keep the Window alive even if all its Views were closed.
|
|
18481
|
-
* This is meant for advanced users and should be used with caution.
|
|
18482
|
-
* Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
|
|
18483
|
-
* Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
|
|
18484
|
-
* ** note ** - This option is ignored in non-Platforms apps.
|
|
18485
|
-
*
|
|
18486
|
-
* @property {boolean} [defaultCentered=false]
|
|
18487
|
-
* Centers the window in the primary monitor. This option overrides `defaultLeft` and `defaultTop`. When `saveWindowState` is `true`,
|
|
18488
|
-
* this value will be ignored for subsequent launches in favor of the cached value. **NOTE:** On macOS _defaultCenter_ is
|
|
18489
|
-
* somewhat above center vertically.
|
|
18490
|
-
*
|
|
18491
|
-
* @property {number} [defaultHeight=500]
|
|
18492
|
-
* The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
|
|
18493
|
-
* in favor of the cached value.
|
|
18494
|
-
*
|
|
18495
|
-
* @property {number} [defaultLeft=100]
|
|
18496
|
-
* The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
|
18497
|
-
* launches in favor of the cached value.
|
|
18498
|
-
*
|
|
18499
|
-
* @property {number} [defaultTop=100]
|
|
18500
|
-
* The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
|
18501
|
-
* launches in favor of the cached value.
|
|
18502
|
-
*
|
|
18503
|
-
* @property {number} [defaultWidth=800]
|
|
18504
|
-
* The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
|
18505
|
-
* launches in favor of the cached value.
|
|
18506
|
-
*
|
|
18507
|
-
* @property {boolean} [includeInSnapshots=true] - _Updatable._
|
|
18508
|
-
* When true, the window will be be included in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
|
|
18509
|
-
* inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
|
|
18510
|
-
*
|
|
18511
|
-
* @property {boolean} [frame=true] - _Updatable._
|
|
18512
|
-
* A flag to show the frame.
|
|
18513
|
-
*
|
|
18514
|
-
* @hidden-property {boolean} [hideOnClose=false] - A flag to allow a window to be hidden when the close button is clicked.
|
|
18515
|
-
*
|
|
18516
|
-
* @property {object[]} [hotkeys=[]] - _Updatable._
|
|
18517
|
-
* Defines the list of hotkeys that will be emitted as a `hotkey` event on the window. For usage example see [example]{@tutorial hotkeys}.
|
|
18518
|
-
* Within Platform, OpenFin also implements a set of pre-defined actions called
|
|
18519
|
-
* [keyboard commands]{@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands}
|
|
18520
|
-
* that can be assigned to a specific hotkey in the platform manifest.
|
|
18521
|
-
* @property {string} hotkeys.keys The key combination of the hotkey, i.e. "Ctrl+T"
|
|
18522
|
-
* @property {boolean} [hotkeys.preventDefault=false] Whether or not to prevent default key handling before emitting the event
|
|
18523
|
-
*
|
|
18524
|
-
* @property {string} [icon] - _Updatable. Inheritable._
|
|
18525
|
-
* A URL for the icon to be shown in the window title bar and the taskbar.
|
|
18526
|
-
* When omitted, inherits from the parent application._
|
|
18527
|
-
* note: Window OS caches taskbar icons, therefore an icon change might only be visible after the cache is removed or the uuid is changed.
|
|
18528
|
-
*
|
|
18529
|
-
* @property {number} [maxHeight=-1] - _Updatable._
|
|
18530
|
-
* The maximum height of a window. Will default to the OS defined value if set to -1.
|
|
18531
|
-
*
|
|
18532
|
-
* @property {boolean} [maximizable=true] - _Updatable._
|
|
18533
|
-
* A flag that lets the window be maximized.
|
|
18534
|
-
*
|
|
18535
|
-
* @property {number} [maxWidth=-1] - _Updatable._
|
|
18536
|
-
* The maximum width of a window. Will default to the OS defined value if set to -1.
|
|
18537
|
-
*
|
|
18538
|
-
* @property {number} [minHeight=0] - _Updatable._
|
|
18539
|
-
* The minimum height of a window.
|
|
18540
|
-
*
|
|
18541
|
-
* @property {boolean} [minimizable=true] - _Updatable._
|
|
18542
|
-
* A flag that lets the window be minimized.
|
|
18543
|
-
*
|
|
18544
|
-
* @property {number} [minWidth=0] - _Updatable._
|
|
18545
|
-
* The minimum width of a window.
|
|
18546
|
-
*
|
|
18547
|
-
* @property {Identity} [modalParentIdentity]
|
|
18548
|
-
* Parent identity of a modal window. It will create a modal child window when this option is set.
|
|
18549
|
-
*
|
|
18550
|
-
* @property {string} name
|
|
18551
|
-
* The name of the window.
|
|
18552
|
-
*
|
|
18553
|
-
* @property {number} [opacity=1.0] - _Updatable._
|
|
18554
|
-
* A flag that specifies how transparent the window will be.
|
|
18555
|
-
* Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
|
|
18556
|
-
* This value is clamped between `0.0` and `1.0`.
|
|
18557
|
-
* * In software composition mode, the runtime flag --allow-unsafe-compositing is required.
|
|
18558
|
-
*
|
|
18559
|
-
* @property {preloadScript[]} [preloadScripts] - _Inheritable_
|
|
18560
|
-
* A list of scripts that are eval'ed before other scripts in the page. When omitted, _inherits_
|
|
18561
|
-
* from the parent application.
|
|
18562
|
-
*
|
|
18563
|
-
* @property {string} [processAffinity]
|
|
18564
|
-
* A string to attempt to group renderers together. Will only be used if pages are on the same origin.
|
|
18565
|
-
*
|
|
18566
|
-
* @property {boolean} [resizable=true] - _Updatable._
|
|
18567
|
-
* A flag to allow the user to resize the window.
|
|
18568
|
-
*
|
|
18569
|
-
* @property {object} [resizeRegion] - _Updatable._
|
|
18570
|
-
* Defines a region in pixels that will respond to user mouse interaction for resizing a frameless window.
|
|
18571
|
-
* @property {number} [resizeRegion.bottomRightCorner=9]
|
|
18572
|
-
* The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
|
|
18573
|
-
* @property {number} [resizeRegion.size=7]
|
|
18574
|
-
* The size in pixels.
|
|
18575
|
-
* @property {object} [resizeRegion.sides={top:true,right:true,bottom:true,left:true}]
|
|
18576
|
-
* Sides that a window can be resized from.
|
|
18577
|
-
*
|
|
18578
|
-
* @property {boolean} [saveWindowState=true]
|
|
18579
|
-
* A flag to cache the location of the window.
|
|
18580
|
-
* ** note ** - This option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
|
|
18581
|
-
*
|
|
18582
|
-
* @property {boolean} [ignoreSavedWindowState]
|
|
18583
|
-
* A flag to ignore previously cached state of the window. It defaults the opposite value of `saveWindowState` to maintain backwards compatibility.
|
|
18584
|
-
*
|
|
18585
|
-
* @property {boolean} [shadow=false]
|
|
18586
|
-
* A flag to display a shadow on frameless windows.
|
|
18587
|
-
* `shadow` and `cornerRounding` are mutually exclusive.
|
|
18588
|
-
* On Windows 7, Aero theme is required.
|
|
18589
|
-
*
|
|
18590
|
-
* @property {boolean} [showBackgroundImages=false] - _Updatable._
|
|
18591
|
-
* Platforms Only. If true, will show background images in the layout when the Views are hidden.
|
|
18592
|
-
* This occurs when the window is resizing or a tab is being dragged within the layout.
|
|
18593
|
-
*
|
|
18594
|
-
* @property {boolean} [showTaskbarIcon=true] - _Updatable._ _Windows_.
|
|
18595
|
-
* A flag to show the window's icon in the taskbar.
|
|
18596
|
-
*
|
|
18597
|
-
* @property {boolean} [smallWindow=false]
|
|
18598
|
-
* A flag to specify a frameless window that can be be created and resized to less than 41x36 px (width x height).
|
|
18599
|
-
* _Note: Caveats of small windows are no Aero Snap and drag to/from maximize._
|
|
18600
|
-
* _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
|
|
18601
|
-
*
|
|
18602
|
-
* @property {boolean} [spellCheck=false]
|
|
18603
|
-
* Enable spell check in input text fields for the window.
|
|
18604
|
-
*
|
|
18605
|
-
* @property {string} [state="normal"]
|
|
18606
|
-
* The visible state of the window on creation.
|
|
18607
|
-
* One of:
|
|
18608
|
-
* * `"maximized"`
|
|
18609
|
-
* * `"minimized"`
|
|
18610
|
-
* * `"normal"`
|
|
18611
|
-
*
|
|
18612
|
-
* @property {string} [taskbarIcon=string] - Deprecated - use `icon` instead._Windows_.
|
|
18613
|
-
*
|
|
18614
|
-
* @property {string} [taskbarIconGroup=<application uuid>] - _Windows_.
|
|
18615
|
-
* Specify a taskbar group for the window.
|
|
18616
|
-
* _If omitted, defaults to app's uuid (`fin.Application.getCurrentSync().identity.uuid`)._
|
|
18617
|
-
*
|
|
18618
|
-
* @property {string} [url="about:blank"]
|
|
18619
|
-
* The URL of the window.
|
|
18620
|
-
*
|
|
18621
|
-
* @property {string} [uuid=<application uuid>]
|
|
18622
|
-
* The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
|
|
18623
|
-
* If omitted, defaults to the `uuid` of the application spawning the window.
|
|
18624
|
-
* If given, must match the `uuid` of the application spawning the window.
|
|
18625
|
-
* In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
|
|
18626
|
-
* really no need to provide it.
|
|
18627
|
-
*
|
|
18628
|
-
* @property {boolean} [waitForPageLoad=false]
|
|
18629
|
-
* When set to `true`, the window will not appear until the `window` object's `load` event fires.
|
|
18630
|
-
* When set to `false`, the window will appear immediately without waiting for content to be loaded.
|
|
18631
|
-
*
|
|
18632
|
-
* @property {ViewVisibility} [viewVisibility]
|
|
18633
|
-
* _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
|
|
18634
|
-
*/
|
|
18635
|
-
/**
|
|
18636
|
-
* @PORTED
|
|
18637
|
-
* @typedef {Object} ViewVisibility@typedef {Object} ViewVisibility _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
|
|
18638
|
-
* @property {ShowViewsOnWindowResize} [showViewsOnWindowResize] Enables views to be shown when a Platform Window is being resized by the user.
|
|
18639
|
-
* @property {ShowViewsOnSplitterDrag} [showViewsOnSplitterDrag] Allows views to be shown when they are resized by the user dragging the splitter between layout stacks.
|
|
18640
|
-
* @property {ShowViewsOnTabDrag} [showViewsOnTabDrag] _Supported on Windows Operating Systems only_. Allows views to be shown when the user is dragging a tab around a layout.
|
|
18641
|
-
*/
|
|
18642
|
-
/**
|
|
18643
|
-
* @PORTED
|
|
18644
|
-
* @typedef {Object} ShowViewsOnWindowResize@typedef {Object} ShowViewsOnWindowResize _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
|
|
18645
|
-
* @property {boolean} [enabled=false] Enables or disables showing Views when a Platform Window is being resized.
|
|
18646
|
-
* @property {number} [paintIntervalMs=0] Number of miliseconds to wait between view repaints.
|
|
18647
|
-
*/
|
|
18648
|
-
/**
|
|
18649
|
-
* @REMOVED
|
|
18650
|
-
* @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.
|
|
18651
|
-
* @property {boolean} [enabled=false] Enables or disables showing views when the layout splitter is being dragged.
|
|
18652
|
-
*/
|
|
18653
|
-
/**
|
|
18654
|
-
* @REMOVED
|
|
18655
|
-
* @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.
|
|
18656
|
-
* @property {boolean} [enabled=false] Enables or disables showing views when a tab is being dragged.
|
|
18657
|
-
*/
|
|
18658
|
-
/**
|
|
18659
|
-
* @PORTED
|
|
18660
|
-
* @typedef {object} CapturePageOptions@typedef {object} CapturePageOptions
|
|
18661
|
-
* @property { Area } [area] The area of the window to be captured.
|
|
18662
|
-
* @property { string } [format='png'] The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
|
|
18663
|
-
* @property { number } [quality=100] Number representing quality of JPEG image only. Between 0 - 100.
|
|
18664
|
-
*/
|
|
18665
|
-
/**
|
|
18666
|
-
* @PORTED
|
|
18667
|
-
* @typedef { object } Area@typedef { object } Area
|
|
18668
|
-
* @property { number } height Area's height
|
|
18669
|
-
* @property { number } width Area's width
|
|
18670
|
-
* @property { number } x X coordinate of area's starting point
|
|
18671
|
-
* @property { number } y Y coordinate of area's starting point
|
|
18672
|
-
*/
|
|
18673
|
-
/**
|
|
18674
|
-
* @PORTED
|
|
18675
|
-
* @typedef {object} FindInPageOptions@typedef {object} FindInPageOptions
|
|
18676
|
-
* @property {boolean} [forward=true] Whether to search forward or backward.
|
|
18677
|
-
* @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.
|
|
18678
|
-
* @property {boolean} [matchCase=false] Whether search should be case-sensitive.
|
|
18679
|
-
* @property {boolean} [wordStart=false] Whether to look only at the start of words.
|
|
18680
|
-
* @property {boolean} [medialCapitalAsWordStart=false]
|
|
18681
|
-
* 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>
|
|
18682
|
-
* lowercase or non-letter. Accepts several other intra-word matches.
|
|
18683
|
-
*/
|
|
18684
|
-
/**
|
|
18685
|
-
* @REMOVED
|
|
18686
|
-
* @typedef {object} Transition@typedef {object} Transition
|
|
18687
|
-
* @property {Opacity} opacity - The Opacity transition
|
|
18688
|
-
* @property {Position} position - The Position transition
|
|
18689
|
-
* @property {Size} size - The Size transition
|
|
18690
|
-
*/
|
|
18691
|
-
/**
|
|
18692
|
-
* @PORTED
|
|
18693
|
-
* @typedef {object} TransitionOptions@typedef {object} TransitionOptions
|
|
18694
|
-
* @property {boolean} interrupt - This option interrupts the current animation. When false it pushes
|
|
18695
|
-
this animation onto the end of the animation queue.
|
|
18696
|
-
* @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
|
|
18697
|
-
*/
|
|
18698
|
-
/**
|
|
18699
|
-
* @PORTED
|
|
18700
|
-
* @typedef {object} Size@typedef {object} Size
|
|
18701
|
-
* @property {number} duration - The total time in milliseconds this transition should take.
|
|
18702
|
-
* @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
|
|
18703
|
-
* @property {number} width - Optional if height is present. Defaults to the window's current width.
|
|
18704
|
-
* @property {number} height - Optional if width is present. Defaults to the window's current height.
|
|
18705
|
-
*/
|
|
18706
|
-
/**
|
|
18707
|
-
* @PORTED
|
|
18708
|
-
* @typedef {object} Position@typedef {object} Position
|
|
18709
|
-
* @property {number} duration - The total time in milliseconds this transition should take.
|
|
18710
|
-
* @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
|
|
18711
|
-
* @property {number} left - Defaults to the window's current left position in virtual screen coordinates.
|
|
18712
|
-
* @property {number} top - Defaults to the window's current top position in virtual screen coordinates.
|
|
18713
|
-
*/
|
|
18714
|
-
/**
|
|
18715
|
-
* @PORTED
|
|
18716
|
-
* @typedef {object} Opacity@typedef {object} Opacity
|
|
18717
|
-
* @property {number} duration - The total time in milliseconds this transition should take.
|
|
18718
|
-
* @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
|
|
18719
|
-
* @property {number} opacity - This value is clamped from 0.0 to 1.0.
|
|
18720
|
-
*/
|
|
18721
|
-
/**
|
|
18722
|
-
* @REMOVED
|
|
18723
|
-
* Bounds is a interface that has the properties of height,
|
|
18724
|
-
* width, left, top which are all numbers
|
|
18725
|
-
* @typedef { object } Bounds@typedef { object } Bounds
|
|
18726
|
-
* @property { number } height Get the application height bound
|
|
18727
|
-
* @property { number } width Get the application width bound
|
|
18728
|
-
* @property { number } top Get the application top bound
|
|
18729
|
-
* @property { number } left Get the application left bound
|
|
18730
|
-
* @property { number } right Get the application right bound
|
|
18731
|
-
* @property { number } bottom Get the application bottom bound
|
|
18732
|
-
*/
|
|
18733
17593
|
/**
|
|
18734
17594
|
* A basic window that wraps a native HTML window. Provides more fine-grained
|
|
18735
17595
|
* control over the window state such as the ability to minimize, maximize, restore, etc.
|
|
@@ -18743,90 +17603,13 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
18743
17603
|
*/
|
|
18744
17604
|
constructor(wire: Transport, identity: OpenFin_2.Identity);
|
|
18745
17605
|
/**
|
|
18746
|
-
*
|
|
18747
|
-
* @
|
|
18748
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
|
18749
|
-
* @param options - Option to support event timestamps.
|
|
18750
|
-
*
|
|
18751
|
-
* @function addListener
|
|
18752
|
-
* @memberof Window
|
|
18753
|
-
* @instance
|
|
18754
|
-
* @tutorial Window.EventEmitter
|
|
17606
|
+
* create a new window
|
|
17607
|
+
* @internal
|
|
18755
17608
|
*/
|
|
17609
|
+
createWindow(options: OpenFin_2.WindowCreationOptions): Promise<OpenFin_2.Window>;
|
|
18756
17610
|
/**
|
|
18757
|
-
*
|
|
18758
|
-
*
|
|
18759
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
|
18760
|
-
* @param options - Option to support event timestamps.
|
|
18761
|
-
*
|
|
18762
|
-
* @function on
|
|
18763
|
-
* @memberof Window
|
|
18764
|
-
* @instance
|
|
18765
|
-
* @tutorial Window.EventEmitter
|
|
18766
|
-
*/
|
|
18767
|
-
/**
|
|
18768
|
-
* 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.
|
|
18769
|
-
* @param eventType - The type of the event.
|
|
18770
|
-
* @param listener - The callback function.
|
|
18771
|
-
* @param options - Option to support event timestamps.
|
|
18772
|
-
*
|
|
18773
|
-
* @function once
|
|
18774
|
-
* @memberof Window
|
|
18775
|
-
* @instance
|
|
18776
|
-
* @tutorial Window.EventEmitter
|
|
18777
|
-
*/
|
|
18778
|
-
/**
|
|
18779
|
-
* Adds a listener to the beginning of the listeners array for the specified event.
|
|
18780
|
-
* @param eventType - The type of the event.
|
|
18781
|
-
* @param listener - The callback function.
|
|
18782
|
-
* @param options - Option to support event timestamps.
|
|
18783
|
-
*
|
|
18784
|
-
* @function prependListener
|
|
18785
|
-
* @memberof Window
|
|
18786
|
-
* @instance
|
|
18787
|
-
* @tutorial Window.EventEmitter
|
|
18788
|
-
*/
|
|
18789
|
-
/**
|
|
18790
|
-
* 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.
|
|
18791
|
-
* The listener is added to the beginning of the listeners array.
|
|
18792
|
-
* @param eventType - The type of the event.
|
|
18793
|
-
* @param listener - The callback function.
|
|
18794
|
-
* @param options - Option to support event timestamps.
|
|
18795
|
-
*
|
|
18796
|
-
* @function prependOnceListener
|
|
18797
|
-
* @memberof Window
|
|
18798
|
-
* @instance
|
|
18799
|
-
* @tutorial Window.EventEmitter
|
|
18800
|
-
*/
|
|
18801
|
-
/**
|
|
18802
|
-
* Remove a listener from the listener array for the specified event.
|
|
18803
|
-
* Caution: Calling this method changes the array indices in the listener array behind the listener.
|
|
18804
|
-
* @param eventType - The type of the event.
|
|
18805
|
-
* @param listener - The callback function.
|
|
18806
|
-
* @param options - Option to support event timestamps.
|
|
18807
|
-
*
|
|
18808
|
-
* @function removeListener
|
|
18809
|
-
* @memberof Window
|
|
18810
|
-
* @instance
|
|
18811
|
-
* @tutorial Window.EventEmitter
|
|
18812
|
-
*/
|
|
18813
|
-
/**
|
|
18814
|
-
* Removes all listeners, or those of the specified event.
|
|
18815
|
-
* @param eventType - The type of the event.
|
|
18816
|
-
*
|
|
18817
|
-
* @function removeAllListeners
|
|
18818
|
-
* @memberof Window
|
|
18819
|
-
* @instance
|
|
18820
|
-
* @tutorial Window.EventEmitter
|
|
18821
|
-
*/
|
|
18822
|
-
/**
|
|
18823
|
-
* create a new window
|
|
18824
|
-
* @internal
|
|
18825
|
-
*/
|
|
18826
|
-
createWindow(options: OpenFin_2.WindowCreationOptions): Promise<OpenFin_2.Window>;
|
|
18827
|
-
/**
|
|
18828
|
-
* Retrieves an array of frame info objects representing the main frame and any
|
|
18829
|
-
* iframes that are currently on the page.
|
|
17611
|
+
* Retrieves an array of frame info objects representing the main frame and any
|
|
17612
|
+
* iframes that are currently on the page.
|
|
18830
17613
|
*
|
|
18831
17614
|
* @example
|
|
18832
17615
|
* ```js
|
|
@@ -19599,10 +18382,9 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
19599
18382
|
show(force?: boolean): Promise<void>;
|
|
19600
18383
|
/**
|
|
19601
18384
|
* Shows the window if it is hidden at the specified location.
|
|
19602
|
-
*
|
|
19603
|
-
*
|
|
19604
|
-
* @param
|
|
19605
|
-
* @param top The right position of the window
|
|
18385
|
+
*
|
|
18386
|
+
* @param left The left position of the window in pixels
|
|
18387
|
+
* @param top The top position of the window in pixels
|
|
19606
18388
|
* @param force Show will be prevented from closing when force is false and
|
|
19607
18389
|
* ‘show-requested’ has been subscribed to for application’s main window
|
|
19608
18390
|
*
|
|
@@ -19664,28 +18446,6 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
19664
18446
|
* ```
|
|
19665
18447
|
*/
|
|
19666
18448
|
authenticate(userName: string, password: string): Promise<void>;
|
|
19667
|
-
/**
|
|
19668
|
-
* @typedef {object} ShowPopupMenuOptions@typedef {object} ShowPopupMenuOptions
|
|
19669
|
-
* @property {Array<MenuItemTemplate>} template - An array describing the menu to show.
|
|
19670
|
-
* @property {number} [x] - The window x coordinate where to show the menu. Defaults to mouse position. If using must also use `y`.
|
|
19671
|
-
* @property {number} [y] - The window y coordinate where to show the menu. Defaults to mouse position. If using must also use `x`
|
|
19672
|
-
*/
|
|
19673
|
-
/**
|
|
19674
|
-
* @typedef {object} MenuItemTemplate@typedef {object} MenuItemTemplate
|
|
19675
|
-
* @property {*} data - Data to be returned if the user selects the element. Must be serializable. Large objects can have a performance impact.
|
|
19676
|
-
* @property {'normal' | 'separator' | 'submenu' | 'checkbox'} [type] - Defaults to 'normal' unless a 'submenu' key exists
|
|
19677
|
-
* @property {string} [label] - The text to show on the menu item. Should be left undefined for `type: 'separator'`
|
|
19678
|
-
* @property {boolean} [enabled] - If false, the menu item will be greyed out and unclickable.
|
|
19679
|
-
* @property {boolean} [visible] - If false, the menu item will be entirely hidden.
|
|
19680
|
-
* @property {boolean} [checked] - Should only be specified for `checkbox` type menu items.
|
|
19681
|
-
* @property {string} [icon] - Image Data URI with image dimensions inferred from the encoded string
|
|
19682
|
-
* @property {Array<MenuItemTemplate>} [submenu] Should be specified for `submenu` type menu items. If `submenu` is specified, the `type: 'submenu'` can be omitted.
|
|
19683
|
-
*/
|
|
19684
|
-
/**
|
|
19685
|
-
* @typedef {object} MenuResult@typedef {object} MenuResult
|
|
19686
|
-
* @property {'clicked' | 'closed'} result - Whether the user clicked on a menu item or the menu was closed (user clicked elsewhere).
|
|
19687
|
-
* @property {* | undefined} [data] - The data property of the menu item clicked by the user. Only defined if result was `clicked`.
|
|
19688
|
-
*/
|
|
19689
18449
|
/**
|
|
19690
18450
|
* Shows a menu on the window.
|
|
19691
18451
|
*
|
|
@@ -19782,590 +18542,565 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
19782
18542
|
*/
|
|
19783
18543
|
closePopupMenu(): Promise<void>;
|
|
19784
18544
|
/**
|
|
19785
|
-
*
|
|
19786
|
-
*
|
|
19787
|
-
* @
|
|
19788
|
-
* @
|
|
19789
|
-
*
|
|
19790
|
-
|
|
19791
|
-
|
|
19792
|
-
|
|
19793
|
-
|
|
19794
|
-
|
|
19795
|
-
|
|
19796
|
-
|
|
19797
|
-
|
|
19798
|
-
|
|
19799
|
-
|
|
19800
|
-
|
|
19801
|
-
|
|
19802
|
-
|
|
19803
|
-
|
|
19804
|
-
|
|
19805
|
-
|
|
19806
|
-
|
|
19807
|
-
|
|
19808
|
-
|
|
19809
|
-
|
|
19810
|
-
|
|
19811
|
-
|
|
19812
|
-
|
|
19813
|
-
|
|
19814
|
-
|
|
19815
|
-
|
|
19816
|
-
|
|
19817
|
-
|
|
19818
|
-
|
|
19819
|
-
|
|
19820
|
-
|
|
19821
|
-
|
|
19822
|
-
|
|
19823
|
-
|
|
19824
|
-
|
|
19825
|
-
|
|
19826
|
-
|
|
19827
|
-
|
|
19828
|
-
|
|
19829
|
-
|
|
19830
|
-
|
|
19831
|
-
|
|
19832
|
-
|
|
19833
|
-
|
|
19834
|
-
|
|
19835
|
-
|
|
19836
|
-
|
|
19837
|
-
|
|
19838
|
-
|
|
19839
|
-
|
|
19840
|
-
|
|
19841
|
-
|
|
19842
|
-
|
|
19843
|
-
|
|
19844
|
-
|
|
19845
|
-
|
|
19846
|
-
|
|
19847
|
-
|
|
19848
|
-
|
|
19849
|
-
|
|
19850
|
-
|
|
19851
|
-
|
|
19852
|
-
|
|
19853
|
-
|
|
19854
|
-
|
|
19855
|
-
|
|
19856
|
-
|
|
19857
|
-
|
|
19858
|
-
|
|
19859
|
-
|
|
19860
|
-
|
|
19861
|
-
|
|
19862
|
-
|
|
19863
|
-
|
|
19864
|
-
|
|
19865
|
-
|
|
19866
|
-
|
|
19867
|
-
|
|
19868
|
-
|
|
19869
|
-
|
|
19870
|
-
|
|
19871
|
-
|
|
19872
|
-
|
|
19873
|
-
|
|
19874
|
-
|
|
19875
|
-
|
|
19876
|
-
|
|
19877
|
-
|
|
19878
|
-
|
|
19879
|
-
|
|
19880
|
-
|
|
19881
|
-
|
|
19882
|
-
|
|
19883
|
-
|
|
19884
|
-
|
|
19885
|
-
|
|
19886
|
-
|
|
19887
|
-
|
|
19888
|
-
|
|
19889
|
-
|
|
19890
|
-
|
|
19891
|
-
|
|
19892
|
-
|
|
19893
|
-
|
|
19894
|
-
|
|
19895
|
-
|
|
19896
|
-
|
|
19897
|
-
|
|
19898
|
-
|
|
19899
|
-
|
|
19900
|
-
|
|
19901
|
-
|
|
19902
|
-
|
|
19903
|
-
|
|
19904
|
-
|
|
19905
|
-
|
|
19906
|
-
|
|
19907
|
-
|
|
19908
|
-
|
|
19909
|
-
|
|
19910
|
-
|
|
19911
|
-
|
|
19912
|
-
|
|
19913
|
-
|
|
19914
|
-
|
|
19915
|
-
|
|
19916
|
-
|
|
19917
|
-
|
|
19918
|
-
|
|
19919
|
-
|
|
19920
|
-
|
|
19921
|
-
|
|
19922
|
-
|
|
19923
|
-
|
|
19924
|
-
|
|
19925
|
-
|
|
19926
|
-
|
|
19927
|
-
|
|
19928
|
-
|
|
19929
|
-
|
|
19930
|
-
|
|
19931
|
-
|
|
19932
|
-
|
|
19933
|
-
|
|
19934
|
-
|
|
19935
|
-
|
|
19936
|
-
|
|
19937
|
-
|
|
19938
|
-
|
|
19939
|
-
|
|
19940
|
-
|
|
19941
|
-
|
|
19942
|
-
|
|
19943
|
-
|
|
19944
|
-
|
|
19945
|
-
|
|
19946
|
-
|
|
19947
|
-
|
|
19948
|
-
|
|
19949
|
-
|
|
19950
|
-
|
|
19951
|
-
|
|
19952
|
-
|
|
19953
|
-
|
|
19954
|
-
|
|
19955
|
-
|
|
19956
|
-
|
|
19957
|
-
|
|
19958
|
-
|
|
19959
|
-
|
|
19960
|
-
|
|
19961
|
-
|
|
19962
|
-
|
|
19963
|
-
|
|
19964
|
-
|
|
19965
|
-
|
|
19966
|
-
|
|
19967
|
-
|
|
19968
|
-
|
|
19969
|
-
|
|
19970
|
-
|
|
19971
|
-
|
|
19972
|
-
|
|
19973
|
-
|
|
19974
|
-
|
|
19975
|
-
|
|
19976
|
-
|
|
19977
|
-
|
|
19978
|
-
|
|
19979
|
-
|
|
19980
|
-
|
|
19981
|
-
|
|
19982
|
-
|
|
19983
|
-
|
|
19984
|
-
|
|
19985
|
-
|
|
19986
|
-
|
|
19987
|
-
|
|
19988
|
-
|
|
19989
|
-
|
|
19990
|
-
|
|
19991
|
-
|
|
19992
|
-
|
|
19993
|
-
|
|
19994
|
-
|
|
19995
|
-
|
|
19996
|
-
|
|
19997
|
-
|
|
19998
|
-
|
|
19999
|
-
|
|
20000
|
-
|
|
20001
|
-
|
|
20002
|
-
|
|
20003
|
-
|
|
20004
|
-
|
|
20005
|
-
|
|
20006
|
-
|
|
20007
|
-
|
|
20008
|
-
|
|
20009
|
-
|
|
20010
|
-
|
|
20011
|
-
|
|
20012
|
-
|
|
20013
|
-
|
|
20014
|
-
|
|
20015
|
-
|
|
20016
|
-
|
|
20017
|
-
|
|
20018
|
-
|
|
20019
|
-
|
|
20020
|
-
|
|
20021
|
-
|
|
20022
|
-
|
|
20023
|
-
|
|
20024
|
-
|
|
20025
|
-
|
|
20026
|
-
|
|
20027
|
-
|
|
20028
|
-
|
|
20029
|
-
|
|
20030
|
-
|
|
20031
|
-
|
|
20032
|
-
|
|
20033
|
-
|
|
20034
|
-
|
|
20035
|
-
|
|
20036
|
-
|
|
20037
|
-
|
|
20038
|
-
|
|
20039
|
-
|
|
20040
|
-
|
|
20041
|
-
|
|
20042
|
-
|
|
20043
|
-
|
|
20044
|
-
|
|
20045
|
-
|
|
20046
|
-
|
|
20047
|
-
|
|
20048
|
-
|
|
20049
|
-
|
|
20050
|
-
|
|
20051
|
-
|
|
20052
|
-
|
|
20053
|
-
|
|
20054
|
-
|
|
20055
|
-
|
|
20056
|
-
|
|
20057
|
-
|
|
20058
|
-
|
|
20059
|
-
|
|
20060
|
-
|
|
20061
|
-
|
|
20062
|
-
|
|
20063
|
-
|
|
20064
|
-
|
|
20065
|
-
|
|
20066
|
-
|
|
20067
|
-
|
|
20068
|
-
|
|
20069
|
-
|
|
20070
|
-
|
|
20071
|
-
|
|
20072
|
-
|
|
20073
|
-
|
|
20074
|
-
|
|
20075
|
-
|
|
20076
|
-
|
|
20077
|
-
|
|
20078
|
-
|
|
20079
|
-
|
|
20080
|
-
|
|
20081
|
-
|
|
20082
|
-
|
|
20083
|
-
|
|
20084
|
-
|
|
20085
|
-
|
|
20086
|
-
|
|
20087
|
-
|
|
20088
|
-
}
|
|
20089
|
-
|
|
20090
|
-
|
|
20091
|
-
|
|
20092
|
-
|
|
20093
|
-
|
|
20094
|
-
|
|
20095
|
-
|
|
20096
|
-
|
|
20097
|
-
|
|
20098
|
-
|
|
20099
|
-
|
|
20100
|
-
|
|
20101
|
-
|
|
20102
|
-
|
|
20103
|
-
|
|
20104
|
-
|
|
20105
|
-
|
|
20106
|
-
|
|
20107
|
-
|
|
20108
|
-
|
|
20109
|
-
|
|
20110
|
-
|
|
20111
|
-
|
|
20112
|
-
|
|
20113
|
-
|
|
20114
|
-
|
|
20115
|
-
|
|
20116
|
-
|
|
20117
|
-
|
|
20118
|
-
|
|
20119
|
-
|
|
20120
|
-
|
|
20121
|
-
|
|
20122
|
-
|
|
20123
|
-
|
|
20124
|
-
|
|
20125
|
-
|
|
20126
|
-
|
|
20127
|
-
|
|
20128
|
-
|
|
20129
|
-
|
|
20130
|
-
|
|
20131
|
-
|
|
20132
|
-
|
|
20133
|
-
|
|
20134
|
-
|
|
20135
|
-
|
|
20136
|
-
|
|
20137
|
-
|
|
20138
|
-
|
|
20139
|
-
|
|
20140
|
-
|
|
20141
|
-
|
|
20142
|
-
|
|
20143
|
-
|
|
20144
|
-
|
|
20145
|
-
|
|
20146
|
-
|
|
20147
|
-
|
|
20148
|
-
|
|
20149
|
-
|
|
20150
|
-
|
|
20151
|
-
|
|
20152
|
-
|
|
20153
|
-
|
|
20154
|
-
|
|
20155
|
-
|
|
20156
|
-
|
|
20157
|
-
|
|
20158
|
-
|
|
20159
|
-
|
|
20160
|
-
|
|
20161
|
-
|
|
20162
|
-
|
|
20163
|
-
|
|
20164
|
-
|
|
20165
|
-
|
|
20166
|
-
|
|
20167
|
-
|
|
20168
|
-
|
|
20169
|
-
|
|
20170
|
-
|
|
20171
|
-
|
|
20172
|
-
|
|
20173
|
-
|
|
20174
|
-
|
|
20175
|
-
|
|
20176
|
-
|
|
20177
|
-
|
|
20178
|
-
|
|
20179
|
-
|
|
20180
|
-
|
|
20181
|
-
|
|
20182
|
-
|
|
20183
|
-
|
|
20184
|
-
|
|
20185
|
-
|
|
20186
|
-
|
|
20187
|
-
|
|
20188
|
-
|
|
20189
|
-
|
|
20190
|
-
|
|
20191
|
-
|
|
20192
|
-
|
|
20193
|
-
|
|
20194
|
-
|
|
20195
|
-
|
|
20196
|
-
|
|
20197
|
-
|
|
20198
|
-
|
|
20199
|
-
|
|
20200
|
-
|
|
20201
|
-
|
|
20202
|
-
|
|
20203
|
-
|
|
20204
|
-
|
|
20205
|
-
|
|
20206
|
-
|
|
20207
|
-
|
|
20208
|
-
|
|
20209
|
-
|
|
20210
|
-
|
|
20211
|
-
|
|
20212
|
-
|
|
20213
|
-
|
|
20214
|
-
|
|
20215
|
-
|
|
20216
|
-
|
|
20217
|
-
|
|
20218
|
-
|
|
20219
|
-
|
|
20220
|
-
|
|
20221
|
-
|
|
20222
|
-
|
|
20223
|
-
|
|
20224
|
-
|
|
20225
|
-
|
|
20226
|
-
|
|
20227
|
-
|
|
20228
|
-
|
|
20229
|
-
|
|
20230
|
-
|
|
20231
|
-
|
|
20232
|
-
|
|
20233
|
-
|
|
20234
|
-
|
|
20235
|
-
|
|
20236
|
-
|
|
20237
|
-
|
|
20238
|
-
|
|
20239
|
-
|
|
20240
|
-
|
|
20241
|
-
|
|
20242
|
-
|
|
20243
|
-
|
|
20244
|
-
|
|
20245
|
-
|
|
20246
|
-
|
|
20247
|
-
|
|
20248
|
-
|
|
20249
|
-
|
|
20250
|
-
|
|
20251
|
-
|
|
20252
|
-
|
|
20253
|
-
|
|
20254
|
-
|
|
20255
|
-
|
|
20256
|
-
|
|
20257
|
-
|
|
20258
|
-
|
|
20259
|
-
|
|
20260
|
-
|
|
20261
|
-
|
|
20262
|
-
|
|
20263
|
-
|
|
20264
|
-
|
|
20265
|
-
|
|
20266
|
-
|
|
20267
|
-
|
|
20268
|
-
|
|
20269
|
-
|
|
20270
|
-
|
|
20271
|
-
|
|
20272
|
-
|
|
20273
|
-
|
|
20274
|
-
|
|
20275
|
-
|
|
20276
|
-
|
|
20277
|
-
|
|
20278
|
-
|
|
20279
|
-
|
|
20280
|
-
|
|
20281
|
-
|
|
20282
|
-
|
|
20283
|
-
|
|
20284
|
-
|
|
20285
|
-
|
|
20286
|
-
|
|
20287
|
-
|
|
20288
|
-
|
|
20289
|
-
|
|
20290
|
-
|
|
20291
|
-
|
|
20292
|
-
|
|
20293
|
-
|
|
20294
|
-
|
|
20295
|
-
|
|
20296
|
-
|
|
20297
|
-
|
|
20298
|
-
|
|
20299
|
-
|
|
20300
|
-
|
|
20301
|
-
|
|
20302
|
-
|
|
20303
|
-
|
|
20304
|
-
|
|
20305
|
-
|
|
20306
|
-
|
|
20307
|
-
|
|
20308
|
-
|
|
20309
|
-
|
|
20310
|
-
|
|
20311
|
-
|
|
20312
|
-
|
|
20313
|
-
|
|
20314
|
-
|
|
20315
|
-
|
|
20316
|
-
|
|
20317
|
-
|
|
20318
|
-
|
|
20319
|
-
|
|
20320
|
-
|
|
20321
|
-
|
|
20322
|
-
|
|
20323
|
-
|
|
20324
|
-
|
|
20325
|
-
|
|
20326
|
-
|
|
20327
|
-
|
|
20328
|
-
|
|
20329
|
-
|
|
20330
|
-
|
|
20331
|
-
|
|
20332
|
-
|
|
20333
|
-
|
|
20334
|
-
|
|
20335
|
-
|
|
20336
|
-
|
|
20337
|
-
|
|
20338
|
-
|
|
20339
|
-
|
|
20340
|
-
|
|
20341
|
-
|
|
20342
|
-
|
|
20343
|
-
|
|
20344
|
-
|
|
20345
|
-
|
|
20346
|
-
|
|
20347
|
-
data: string;
|
|
20348
|
-
};
|
|
20349
|
-
|
|
20350
|
-
/**
|
|
20351
|
-
* @interface
|
|
20352
|
-
*/
|
|
20353
|
-
declare type WriteImageClipboardRequest = BaseClipboardRequest & {
|
|
20354
|
-
/**
|
|
20355
|
-
* Can be either a base64 string, or a DataURL string. If using DataURL, the
|
|
20356
|
-
* supported formats are `data:image/png[;base64],` and `data:image/jpeg[;base64],`.
|
|
20357
|
-
* Using other image/<format> DataURLs will throw an Error.
|
|
20358
|
-
*/
|
|
20359
|
-
image: string;
|
|
20360
|
-
};
|
|
20361
|
-
|
|
20362
|
-
/**
|
|
20363
|
-
* @deprecated - instead use OpenFin.WriteClipboardRequest
|
|
20364
|
-
*
|
|
20365
|
-
* A request to write data to the clipboard.
|
|
20366
|
-
*
|
|
20367
|
-
* @interface
|
|
20368
|
-
*/
|
|
20369
|
-
declare type WriteRequestType = WriteClipboardRequest;
|
|
20370
|
-
|
|
20371
|
-
export { }
|
|
18545
|
+
* Dispatch a result to the caller of `showPopupWindow`.
|
|
18546
|
+
*
|
|
18547
|
+
* @remarks If this window isn't currently being shown as a popup, this call will silently fail.
|
|
18548
|
+
* @param data Serializable data to send to the caller window.
|
|
18549
|
+
*
|
|
18550
|
+
* @example
|
|
18551
|
+
* ```js
|
|
18552
|
+
* await fin.me.dispatchPopupResult({
|
|
18553
|
+
* foo: 'bar'
|
|
18554
|
+
* });
|
|
18555
|
+
* ```
|
|
18556
|
+
*/
|
|
18557
|
+
dispatchPopupResult(data: any): Promise<void>;
|
|
18558
|
+
/**
|
|
18559
|
+
* Prints the contents of the window.
|
|
18560
|
+
*
|
|
18561
|
+
* @param options Configuration for the print task.
|
|
18562
|
+
* @remarks When `silent` is set to `true`, the API will pick the system's default printer if deviceName is empty
|
|
18563
|
+
* and the default settings for printing.
|
|
18564
|
+
*
|
|
18565
|
+
* Use the CSS style `page-break-before: always;` to force print to a new page.
|
|
18566
|
+
*
|
|
18567
|
+
* @example
|
|
18568
|
+
* ```js
|
|
18569
|
+
* const win = fin.Window.getCurrentSync();
|
|
18570
|
+
*
|
|
18571
|
+
* win.print({ silent: false, deviceName: 'system-printer-name' }).then(() => {
|
|
18572
|
+
* console.log('print call has been sent to the system');
|
|
18573
|
+
* });
|
|
18574
|
+
* ```
|
|
18575
|
+
*
|
|
18576
|
+
* If a window has embedded views, those views will not print by default. To print a window's contents including embedded views,
|
|
18577
|
+
* use the `content` option:
|
|
18578
|
+
*
|
|
18579
|
+
* ```js
|
|
18580
|
+
* const win = fin.Window.getCurrentSync();
|
|
18581
|
+
*
|
|
18582
|
+
* // Print embedded views
|
|
18583
|
+
* win.print({ content: 'views' });
|
|
18584
|
+
*
|
|
18585
|
+
* // Print screenshot of current window
|
|
18586
|
+
* win.print({ content: 'screenshot' })
|
|
18587
|
+
* ```
|
|
18588
|
+
*
|
|
18589
|
+
* When `content` is set to `views`, the embedded views in the platform window will be concatenated and printed as
|
|
18590
|
+
* individual pages. If `includeSelf` is set to `true`, the platform window itself will be printed as the first
|
|
18591
|
+
* page - be aware that this page will *not* include the embedded views - it will only include the contents of
|
|
18592
|
+
* the platform window itself (e.g. tab stacks), with blank spaces where the view contents would be embedded.
|
|
18593
|
+
*
|
|
18594
|
+
* Due to a known issue, view contents that are not visible at the time `print` is called will not appear when
|
|
18595
|
+
* printing `contents: views`. This includes views that are obscured behind other active UI elements.
|
|
18596
|
+
*
|
|
18597
|
+
* To print the views embedded in their page context, set `content` to `screenshot`.
|
|
18598
|
+
*/
|
|
18599
|
+
print(options?: OpenFin_2.WindowPrintOptions): Promise<void>;
|
|
18600
|
+
}
|
|
18601
|
+
|
|
18602
|
+
/**
|
|
18603
|
+
* Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
|
|
18604
|
+
* @interface
|
|
18605
|
+
*/
|
|
18606
|
+
declare type WindowAlertRequestedEvent = BaseEvent_3 & {
|
|
18607
|
+
type: 'window-alert-requested';
|
|
18608
|
+
};
|
|
18609
|
+
|
|
18610
|
+
/**
|
|
18611
|
+
* Returned from getBounds call. bottom and right are never used for setting.
|
|
18612
|
+
* @interface
|
|
18613
|
+
*/
|
|
18614
|
+
declare type WindowBounds = Bounds & {
|
|
18615
|
+
bottom: number;
|
|
18616
|
+
right: number;
|
|
18617
|
+
};
|
|
18618
|
+
|
|
18619
|
+
/**
|
|
18620
|
+
* @deprecated Renamed to {@link ClosedEvent}.
|
|
18621
|
+
*/
|
|
18622
|
+
declare type WindowClosedEvent = ClosedEvent_2;
|
|
18623
|
+
|
|
18624
|
+
/**
|
|
18625
|
+
* @deprecated Renamed to {@link CloseRequestedEvent}.
|
|
18626
|
+
*/
|
|
18627
|
+
declare type WindowCloseRequestedEvent = CloseRequestedEvent;
|
|
18628
|
+
|
|
18629
|
+
/**
|
|
18630
|
+
* @deprecated Renamed to {@link ClosingEvent}.
|
|
18631
|
+
*/
|
|
18632
|
+
declare type WindowClosingEvent = ClosingEvent;
|
|
18633
|
+
|
|
18634
|
+
/**
|
|
18635
|
+
* A rule prescribing content creation in a {@link OpenFin.Window}.
|
|
18636
|
+
*
|
|
18637
|
+
* @interface
|
|
18638
|
+
*/
|
|
18639
|
+
declare type WindowContentCreationRule = BaseContentCreationRule & {
|
|
18640
|
+
/**
|
|
18641
|
+
* Behavior to use when opening matched content.
|
|
18642
|
+
*/
|
|
18643
|
+
behavior: 'window';
|
|
18644
|
+
/**
|
|
18645
|
+
* Options for newly-created window.
|
|
18646
|
+
*/
|
|
18647
|
+
options?: Partial<WindowOptions>;
|
|
18648
|
+
};
|
|
18649
|
+
|
|
18650
|
+
/**
|
|
18651
|
+
* Generated when a child window is created.
|
|
18652
|
+
* @interface
|
|
18653
|
+
*/
|
|
18654
|
+
declare type WindowCreatedEvent = BaseEvent_3 & {
|
|
18655
|
+
type: 'window-created';
|
|
18656
|
+
};
|
|
18657
|
+
|
|
18658
|
+
/**
|
|
18659
|
+
* Options required to create a new window with {@link Window._WindowModule.create Window.create}.
|
|
18660
|
+
*
|
|
18661
|
+
* Note that `name` is the only required property — albeit the `url` property is usually provided as well
|
|
18662
|
+
* (defaults to `"about:blank"` when omitted).
|
|
18663
|
+
* @interface
|
|
18664
|
+
*/
|
|
18665
|
+
declare type WindowCreationOptions = Partial<WindowOptions> & {
|
|
18666
|
+
name: string;
|
|
18667
|
+
};
|
|
18668
|
+
|
|
18669
|
+
declare type WindowCreationReason = 'tearout' | 'create-view-without-target' | 'api-call' | 'app-creation' | 'restore' | 'apply-snapshot';
|
|
18670
|
+
|
|
18671
|
+
/**
|
|
18672
|
+
* @interface
|
|
18673
|
+
*/
|
|
18674
|
+
declare type WindowDetail = {
|
|
18675
|
+
/**
|
|
18676
|
+
* The bottom-most coordinate of the window.
|
|
18677
|
+
*/
|
|
18678
|
+
bottom: number;
|
|
18679
|
+
/**
|
|
18680
|
+
* The height of the window.
|
|
18681
|
+
*/
|
|
18682
|
+
height: number;
|
|
18683
|
+
isShowing: boolean;
|
|
18684
|
+
/**
|
|
18685
|
+
* The left-most coordinate of the window.
|
|
18686
|
+
*/
|
|
18687
|
+
left: number;
|
|
18688
|
+
/**
|
|
18689
|
+
* The name of the window.
|
|
18690
|
+
*/
|
|
18691
|
+
name: string;
|
|
18692
|
+
/**
|
|
18693
|
+
* The right-most coordinate of the window.
|
|
18694
|
+
*/
|
|
18695
|
+
right: number;
|
|
18696
|
+
state: string;
|
|
18697
|
+
/**
|
|
18698
|
+
* The top-most coordinate of the window.
|
|
18699
|
+
*/
|
|
18700
|
+
top: number;
|
|
18701
|
+
/**
|
|
18702
|
+
* The width of the window.
|
|
18703
|
+
*/
|
|
18704
|
+
width: number;
|
|
18705
|
+
};
|
|
18706
|
+
|
|
18707
|
+
/**
|
|
18708
|
+
* Generated when a child window ends loading.
|
|
18709
|
+
* @interface
|
|
18710
|
+
*/
|
|
18711
|
+
declare type WindowEndLoadEvent = BaseEvent_3 & {
|
|
18712
|
+
type: 'window-end-load';
|
|
18713
|
+
};
|
|
18714
|
+
|
|
18715
|
+
/**
|
|
18716
|
+
* @deprecated, Renamed to {@link Event}.
|
|
18717
|
+
*/
|
|
18718
|
+
declare type WindowEvent = Event_6;
|
|
18719
|
+
|
|
18720
|
+
declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
|
|
18721
|
+
|
|
18722
|
+
declare namespace WindowEvents {
|
|
18723
|
+
export {
|
|
18724
|
+
BaseEvent_5 as BaseEvent,
|
|
18725
|
+
BaseWindowEvent,
|
|
18726
|
+
ViewAttachedEvent,
|
|
18727
|
+
ViewDetachedEvent,
|
|
18728
|
+
WindowViewEvent,
|
|
18729
|
+
AlertRequestedEvent,
|
|
18730
|
+
AuthRequestedEvent,
|
|
18731
|
+
EndLoadEvent,
|
|
18732
|
+
WillRedirectEvent,
|
|
18733
|
+
ReloadedEvent,
|
|
18734
|
+
OptionsChangedEvent,
|
|
18735
|
+
WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
|
|
18736
|
+
ExternalProcessExitedEvent,
|
|
18737
|
+
ExternalProcessStartedEvent,
|
|
18738
|
+
HiddenEvent_2 as HiddenEvent,
|
|
18739
|
+
WindowHiddenEvent,
|
|
18740
|
+
PreloadScriptInfoRunning,
|
|
18741
|
+
PreloadScriptInfo,
|
|
18742
|
+
PreloadScriptsStateChangeEvent,
|
|
18743
|
+
UserBoundsChangeEvent,
|
|
18744
|
+
BoundsChangeEvent,
|
|
18745
|
+
WillMoveOrResizeEvent,
|
|
18746
|
+
PerformanceReportEvent,
|
|
18747
|
+
InputEvent_2 as InputEvent,
|
|
18748
|
+
LayoutInitializedEvent,
|
|
18749
|
+
LayoutReadyEvent,
|
|
18750
|
+
BeginUserBoundsChangingEvent,
|
|
18751
|
+
BoundsChangedEvent,
|
|
18752
|
+
BoundsChangingEvent,
|
|
18753
|
+
CloseRequestedEvent,
|
|
18754
|
+
WindowCloseRequestedEvent,
|
|
18755
|
+
ContextChangedEvent,
|
|
18756
|
+
ClosedEvent_2 as ClosedEvent,
|
|
18757
|
+
WindowClosedEvent,
|
|
18758
|
+
ClosingEvent,
|
|
18759
|
+
WindowClosingEvent,
|
|
18760
|
+
DisabledMovementBoundsChangedEvent,
|
|
18761
|
+
DisabledMovementBoundsChangingEvent,
|
|
18762
|
+
EmbeddedEvent,
|
|
18763
|
+
EndUserBoundsChangingEvent,
|
|
18764
|
+
HotkeyEvent_2 as HotkeyEvent,
|
|
18765
|
+
WindowHotkeyEvent,
|
|
18766
|
+
InitializedEvent_2 as InitializedEvent,
|
|
18767
|
+
WindowInitializedEvent,
|
|
18768
|
+
MaximizedEvent,
|
|
18769
|
+
MinimizedEvent,
|
|
18770
|
+
PreloadScriptsStateChangedEvent,
|
|
18771
|
+
PreloadScriptsStateChangingEvent,
|
|
18772
|
+
RestoredEvent,
|
|
18773
|
+
WindowRestoredEvent,
|
|
18774
|
+
ShowRequestedEvent,
|
|
18775
|
+
WindowShowRequestedEvent,
|
|
18776
|
+
ShownEvent_2 as ShownEvent,
|
|
18777
|
+
WindowShownEvent,
|
|
18778
|
+
UserMovementEnabledEvent,
|
|
18779
|
+
UserMovementDisabledEvent,
|
|
18780
|
+
WillMoveEvent,
|
|
18781
|
+
WillResizeEvent,
|
|
18782
|
+
NonPropagatedWindowEvent,
|
|
18783
|
+
ShowAllDownloadsEvent,
|
|
18784
|
+
DownloadShelfVisibilityChangedEvent,
|
|
18785
|
+
WindowSourcedEvent,
|
|
18786
|
+
WillPropagateWindowEvent,
|
|
18787
|
+
Event_6 as Event,
|
|
18788
|
+
WindowEvent,
|
|
18789
|
+
EventType_2 as EventType,
|
|
18790
|
+
WindowEventType,
|
|
18791
|
+
PropagatedEvent_3 as PropagatedEvent,
|
|
18792
|
+
PropagatedWindowEvent,
|
|
18793
|
+
PropagatedWindowEventType,
|
|
18794
|
+
Payload_3 as Payload,
|
|
18795
|
+
ByType_2 as ByType
|
|
18796
|
+
}
|
|
18797
|
+
}
|
|
18798
|
+
|
|
18799
|
+
/**
|
|
18800
|
+
* @deprecated Renamed to {@link EventType}.
|
|
18801
|
+
*/
|
|
18802
|
+
declare type WindowEventType = WindowEvent['type'];
|
|
18803
|
+
|
|
18804
|
+
/**
|
|
18805
|
+
* @deprecated Renamed to {@link HiddenEvent}.
|
|
18806
|
+
*/
|
|
18807
|
+
declare type WindowHiddenEvent = HiddenEvent_2;
|
|
18808
|
+
|
|
18809
|
+
/**
|
|
18810
|
+
* @deprecated Renamed to {@link HotkeyEvent}.
|
|
18811
|
+
*/
|
|
18812
|
+
declare type WindowHotkeyEvent = HotkeyEvent_2;
|
|
18813
|
+
|
|
18814
|
+
/**
|
|
18815
|
+
* @interface
|
|
18816
|
+
*/
|
|
18817
|
+
declare type WindowInfo = {
|
|
18818
|
+
canNavigateBack: boolean;
|
|
18819
|
+
canNavigateForward: boolean;
|
|
18820
|
+
preloadScripts: Array<any>;
|
|
18821
|
+
title: string;
|
|
18822
|
+
url: string;
|
|
18823
|
+
};
|
|
18824
|
+
|
|
18825
|
+
/**
|
|
18826
|
+
* @deprecated Renamed to {@link InitializedEvent}.
|
|
18827
|
+
*/
|
|
18828
|
+
declare type WindowInitializedEvent = InitializedEvent_2;
|
|
18829
|
+
|
|
18830
|
+
/**
|
|
18831
|
+
* Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
|
|
18832
|
+
*/
|
|
18833
|
+
declare class _WindowModule extends Base {
|
|
18834
|
+
/**
|
|
18835
|
+
* Asynchronously returns a Window object that represents an existing window.
|
|
18836
|
+
*
|
|
18837
|
+
* @example
|
|
18838
|
+
* ```js
|
|
18839
|
+
* async function createWin() {
|
|
18840
|
+
* const app = await fin.Application.start({
|
|
18841
|
+
* name: 'myApp',
|
|
18842
|
+
* uuid: 'app-1',
|
|
18843
|
+
* url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrap.html',
|
|
18844
|
+
* autoShow: true
|
|
18845
|
+
* });
|
|
18846
|
+
* return await app.getWindow();
|
|
18847
|
+
* }
|
|
18848
|
+
* createWin().then(() => fin.Window.wrap({ uuid: 'app-1', name: 'myApp' }))
|
|
18849
|
+
* .then(win => console.log('wrapped window'))
|
|
18850
|
+
* .catch(err => console.log(err));
|
|
18851
|
+
* ```
|
|
18852
|
+
*/
|
|
18853
|
+
wrap(identity: OpenFin_2.Identity): Promise<OpenFin_2.Window>;
|
|
18854
|
+
/**
|
|
18855
|
+
* Synchronously returns a Window object that represents an existing window.
|
|
18856
|
+
*
|
|
18857
|
+
* @example
|
|
18858
|
+
* ```js
|
|
18859
|
+
* async function createWin() {
|
|
18860
|
+
* const app = await fin.Application.start({
|
|
18861
|
+
* name: 'myApp',
|
|
18862
|
+
* uuid: 'app-1',
|
|
18863
|
+
* url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrapSync.html',
|
|
18864
|
+
* autoShow: true
|
|
18865
|
+
* });
|
|
18866
|
+
* return await app.getWindow();
|
|
18867
|
+
* }
|
|
18868
|
+
* await createWin();
|
|
18869
|
+
* let win = fin.Window.wrapSync({ uuid: 'app-1', name: 'myApp' });
|
|
18870
|
+
* ```
|
|
18871
|
+
*/
|
|
18872
|
+
wrapSync(identity: OpenFin_2.Identity): OpenFin_2.Window;
|
|
18873
|
+
/**
|
|
18874
|
+
* Creates a new Window.
|
|
18875
|
+
* @param options - Window creation options
|
|
18876
|
+
*
|
|
18877
|
+
* @example
|
|
18878
|
+
* ```js
|
|
18879
|
+
* async function createWindow() {
|
|
18880
|
+
* const winOption = {
|
|
18881
|
+
* name:'child',
|
|
18882
|
+
* defaultWidth: 300,
|
|
18883
|
+
* defaultHeight: 300,
|
|
18884
|
+
* url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.create.html',
|
|
18885
|
+
* frame: true,
|
|
18886
|
+
* autoShow: true
|
|
18887
|
+
* };
|
|
18888
|
+
* return await fin.Window.create(winOption);
|
|
18889
|
+
* }
|
|
18890
|
+
*
|
|
18891
|
+
* createWindow().then(() => console.log('Window is created')).catch(err => console.log(err));
|
|
18892
|
+
* ```
|
|
18893
|
+
*/
|
|
18894
|
+
create(options: OpenFin_2.WindowCreationOptions): Promise<OpenFin_2.Window>;
|
|
18895
|
+
/**
|
|
18896
|
+
* Asynchronously returns a Window object that represents the current window
|
|
18897
|
+
*
|
|
18898
|
+
* @example
|
|
18899
|
+
* ```js
|
|
18900
|
+
* fin.Window.getCurrent()
|
|
18901
|
+
* .then(wnd => console.log('current window'))
|
|
18902
|
+
* .catch(err => console.log(err));
|
|
18903
|
+
*
|
|
18904
|
+
* ```
|
|
18905
|
+
*/
|
|
18906
|
+
getCurrent(): Promise<OpenFin_2.Window>;
|
|
18907
|
+
/**
|
|
18908
|
+
* Synchronously returns a Window object that represents the current window
|
|
18909
|
+
*
|
|
18910
|
+
* @example
|
|
18911
|
+
* ```js
|
|
18912
|
+
* const wnd = fin.Window.getCurrentSync();
|
|
18913
|
+
* const info = await wnd.getInfo();
|
|
18914
|
+
* console.log(info);
|
|
18915
|
+
*
|
|
18916
|
+
* ```
|
|
18917
|
+
*/
|
|
18918
|
+
getCurrentSync(): OpenFin_2.Window;
|
|
18919
|
+
}
|
|
18920
|
+
|
|
18921
|
+
/**
|
|
18922
|
+
* Generated when a child window is not responding.
|
|
18923
|
+
* @interface
|
|
18924
|
+
*/
|
|
18925
|
+
declare type WindowNotRespondingEvent = BaseEvent_3 & {
|
|
18926
|
+
type: 'window-not-responding';
|
|
18927
|
+
};
|
|
18928
|
+
|
|
18929
|
+
/**
|
|
18930
|
+
* @interface
|
|
18931
|
+
*/
|
|
18932
|
+
declare type WindowOptionDiff = {
|
|
18933
|
+
[key in keyof WindowOptions]: {
|
|
18934
|
+
oldVal: WindowOptions[key];
|
|
18935
|
+
newVal: WindowOptions[key];
|
|
18936
|
+
};
|
|
18937
|
+
};
|
|
18938
|
+
|
|
18939
|
+
/**
|
|
18940
|
+
* @interface
|
|
18941
|
+
*/
|
|
18942
|
+
declare type WindowOptions = MutableWindowOptions & ConstWindowOptions;
|
|
18943
|
+
|
|
18944
|
+
declare type WindowOptionsChangedEvent = OpenFin_2.WindowEvents.WindowOptionsChangedEvent;
|
|
18945
|
+
|
|
18946
|
+
/**
|
|
18947
|
+
* @deprecated Renamed to {@link OptionsChangedEvent}.
|
|
18948
|
+
*/
|
|
18949
|
+
declare type WindowOptionsChangedEvent_2 = OptionsChangedEvent;
|
|
18950
|
+
|
|
18951
|
+
declare type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
|
|
18952
|
+
|
|
18953
|
+
/**
|
|
18954
|
+
* Generated when a child window is responding.
|
|
18955
|
+
* @interface
|
|
18956
|
+
*/
|
|
18957
|
+
declare type WindowRespondingEvent = BaseEvent_3 & {
|
|
18958
|
+
type: 'window-responding';
|
|
18959
|
+
};
|
|
18960
|
+
|
|
18961
|
+
/**
|
|
18962
|
+
* @deprecated Renamed to {@link RestoredEvent}.
|
|
18963
|
+
*/
|
|
18964
|
+
declare type WindowRestoredEvent = RestoredEvent;
|
|
18965
|
+
|
|
18966
|
+
/**
|
|
18967
|
+
* @deprecated Renamed to {@link ShownEvent}.
|
|
18968
|
+
*/
|
|
18969
|
+
declare type WindowShownEvent = ShownEvent_2;
|
|
18970
|
+
|
|
18971
|
+
/**
|
|
18972
|
+
* @deprecated Renamed to {@link ShowRequestedEvent}.
|
|
18973
|
+
*/
|
|
18974
|
+
declare type WindowShowRequestedEvent = ShowRequestedEvent;
|
|
18975
|
+
|
|
18976
|
+
/**
|
|
18977
|
+
* A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
|
|
18978
|
+
* from {@link OpenFin.ViewEvents}.
|
|
18979
|
+
*/
|
|
18980
|
+
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;
|
|
18981
|
+
|
|
18982
|
+
/**
|
|
18983
|
+
* Generated when a child window starts loading.
|
|
18984
|
+
* @interface
|
|
18985
|
+
*/
|
|
18986
|
+
declare type WindowStartLoadEvent = BaseEvent_3 & {
|
|
18987
|
+
type: 'window-start-load';
|
|
18988
|
+
};
|
|
18989
|
+
|
|
18990
|
+
/**
|
|
18991
|
+
* Visibility state of a window.
|
|
18992
|
+
*/
|
|
18993
|
+
declare type WindowState = 'maximized' | 'minimized' | 'normal';
|
|
18994
|
+
|
|
18995
|
+
/**
|
|
18996
|
+
* A view-related event that fires natively on the `Window` topic. This means that these events *do* propagate
|
|
18997
|
+
* to the `Application` level, with the name pattern `window-view-eventname`.
|
|
18998
|
+
*/
|
|
18999
|
+
declare type WindowViewEvent = {
|
|
19000
|
+
viewIdentity: OpenFin_2.Identity;
|
|
19001
|
+
} & (ViewAttachedEvent | ViewDetachedEvent);
|
|
19002
|
+
|
|
19003
|
+
/**
|
|
19004
|
+
* @interface
|
|
19005
|
+
*/
|
|
19006
|
+
declare type WindowViewsPrintOptions = {
|
|
19007
|
+
content: 'views';
|
|
19008
|
+
includeSelf?: boolean;
|
|
19009
|
+
};
|
|
19010
|
+
|
|
19011
|
+
declare type Wire = EventEmitter & {
|
|
19012
|
+
connect(messageReciever: MessageReceiver): Promise<any>;
|
|
19013
|
+
connectSync(): any;
|
|
19014
|
+
send(data: any): Promise<any>;
|
|
19015
|
+
shutdown(): Promise<void>;
|
|
19016
|
+
getPort(): string;
|
|
19017
|
+
};
|
|
19018
|
+
|
|
19019
|
+
declare type WireConstructor = {
|
|
19020
|
+
new (onmessage: (data: any) => void): Wire;
|
|
19021
|
+
};
|
|
19022
|
+
|
|
19023
|
+
/**
|
|
19024
|
+
* @internal
|
|
19025
|
+
*/
|
|
19026
|
+
declare type WithId<T extends AppVersionEventType> = `${T}.${string}`;
|
|
19027
|
+
|
|
19028
|
+
declare interface WithInterop {
|
|
19029
|
+
interop: InteropClient;
|
|
19030
|
+
}
|
|
19031
|
+
|
|
19032
|
+
/**
|
|
19033
|
+
* @internal
|
|
19034
|
+
*/
|
|
19035
|
+
declare type WithoutId<T extends string> = T extends WithId<infer U> ? U : never;
|
|
19036
|
+
|
|
19037
|
+
declare type WithPositioningOptions<T extends {} = {}> = T & {
|
|
19038
|
+
positioningOptions?: OpenFin_2.PositioningOptions;
|
|
19039
|
+
};
|
|
19040
|
+
|
|
19041
|
+
/**
|
|
19042
|
+
* @internal
|
|
19043
|
+
* @interface
|
|
19044
|
+
*/
|
|
19045
|
+
declare type WorkspacePlatformOptions = {
|
|
19046
|
+
/** Leaving this as any for now until we figure out what the shape should look like in Workspace */
|
|
19047
|
+
[key: string]: any;
|
|
19048
|
+
};
|
|
19049
|
+
|
|
19050
|
+
/**
|
|
19051
|
+
* A generic request to write any supported data to the clipboard.
|
|
19052
|
+
* @interface
|
|
19053
|
+
*/
|
|
19054
|
+
declare type WriteAnyClipboardRequest = BaseClipboardRequest & {
|
|
19055
|
+
/**
|
|
19056
|
+
* Data to be written
|
|
19057
|
+
*/
|
|
19058
|
+
data: {
|
|
19059
|
+
text?: string;
|
|
19060
|
+
html?: string;
|
|
19061
|
+
rtf?: string;
|
|
19062
|
+
} & Partial<Pick<WriteImageClipboardRequest, 'image'>>;
|
|
19063
|
+
};
|
|
19064
|
+
|
|
19065
|
+
/**
|
|
19066
|
+
* @deprecated - instead use WriteAnyClipboardRequest
|
|
19067
|
+
*
|
|
19068
|
+
* A generic request to write any supported data to the clipboard.
|
|
19069
|
+
*
|
|
19070
|
+
* @interface
|
|
19071
|
+
*/
|
|
19072
|
+
declare type WriteAnyRequestType = WriteAnyClipboardRequest;
|
|
19073
|
+
|
|
19074
|
+
/**
|
|
19075
|
+
* A request to write data to the clipboard.
|
|
19076
|
+
* @interface
|
|
19077
|
+
*/
|
|
19078
|
+
declare type WriteClipboardRequest = BaseClipboardRequest & {
|
|
19079
|
+
/**
|
|
19080
|
+
* Data to write to the clipboard.
|
|
19081
|
+
*/
|
|
19082
|
+
data: string;
|
|
19083
|
+
};
|
|
19084
|
+
|
|
19085
|
+
/**
|
|
19086
|
+
* @interface
|
|
19087
|
+
*/
|
|
19088
|
+
declare type WriteImageClipboardRequest = BaseClipboardRequest & {
|
|
19089
|
+
/**
|
|
19090
|
+
* Can be either a base64 string, or a DataURL string. If using DataURL, the
|
|
19091
|
+
* supported formats are `data:image/png[;base64],` and `data:image/jpeg[;base64],`.
|
|
19092
|
+
* Using other image/<format> DataURLs will throw an Error.
|
|
19093
|
+
*/
|
|
19094
|
+
image: string;
|
|
19095
|
+
};
|
|
19096
|
+
|
|
19097
|
+
/**
|
|
19098
|
+
* @deprecated - instead use OpenFin.WriteClipboardRequest
|
|
19099
|
+
*
|
|
19100
|
+
* A request to write data to the clipboard.
|
|
19101
|
+
*
|
|
19102
|
+
* @interface
|
|
19103
|
+
*/
|
|
19104
|
+
declare type WriteRequestType = WriteClipboardRequest;
|
|
19105
|
+
|
|
19106
|
+
export { }
|