@openfin/core 35.78.2 → 35.78.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/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 true `fin` won't be available in this context.
101
+ */
102
+ preventInjection?: boolean;
97
103
  };
98
104
 
99
105
  declare type ApiCall<Request, Response> = {
@@ -193,100 +199,6 @@ declare class Application extends EmitterBase<OpenFin_2.ApplicationEvent> {
193
199
  */
194
200
  constructor(wire: Transport, identity: OpenFin_2.ApplicationIdentity);
195
201
  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
202
  /**
291
203
  * Determines if the application is currently running.
292
204
  *
@@ -924,7 +836,6 @@ declare namespace ApplicationEvents {
924
836
  WindowRespondingEvent,
925
837
  WindowStartLoadEvent,
926
838
  ApplicationWindowEvent,
927
- ApplicationWindowEventTypes,
928
839
  ClosedEvent,
929
840
  ConnectedEvent_2 as ConnectedEvent,
930
841
  ApplicationConnectedEvent,
@@ -934,6 +845,7 @@ declare namespace ApplicationEvents {
934
845
  RespondingEvent,
935
846
  StartedEvent,
936
847
  ApplicationSourcedEvent,
848
+ ApplicationSourcedEventType,
937
849
  Event_3 as Event,
938
850
  ApplicationEvent,
939
851
  EventType_3 as EventType,
@@ -1306,6 +1218,11 @@ declare type ApplicationPermissions = {
1306
1218
  */
1307
1219
  declare type ApplicationSourcedEvent = ClosedEvent | ConnectedEvent_2 | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent_2 | StartedEvent | TrayIconClickedEvent | FileDownloadLocationChangedEvent;
1308
1220
 
1221
+ /**
1222
+ * Union of possible type values for an {@link ApplicationSourcedEvent}.
1223
+ */
1224
+ declare type ApplicationSourcedEventType = ApplicationSourcedEvent['type'];
1225
+
1309
1226
  declare type ApplicationState = OpenFin_2.ApplicationState;
1310
1227
 
1311
1228
  /**
@@ -1343,11 +1260,6 @@ declare type ApplicationType = {
1343
1260
  */
1344
1261
  declare type ApplicationWindowEvent = WindowAlertRequestedEvent | WindowCreatedEvent | WindowEndLoadEvent | WindowNotRespondingEvent | WindowRespondingEvent | WindowStartLoadEvent;
1345
1262
 
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
1263
  declare type ApplicationWindowInfo = OpenFin_2.ApplicationWindowInfo;
1352
1264
 
1353
1265
  /**
@@ -3148,20 +3060,6 @@ declare type ClientInfo = Omit<ClientIdentity, 'isLocalEndpointId'> & {
3148
3060
  connectionUrl: string;
3149
3061
  };
3150
3062
 
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
3063
  /**
3166
3064
  * The Clipboard API allows reading and writing to the clipboard in multiple formats.
3167
3065
  *
@@ -3417,57 +3315,6 @@ declare type ClosingEvent = BaseEvent_5 & {
3417
3315
  */
3418
3316
  declare class ColumnOrRow extends LayoutNode {
3419
3317
  #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
3318
  /**
3472
3319
  * @internal
3473
3320
  */
@@ -3588,6 +3435,10 @@ declare type ConstructorOverride<T> = (Base: Constructor<T>) => Constructor<T>;
3588
3435
  * @interface
3589
3436
  */
3590
3437
  declare type ConstViewOptions = {
3438
+ /**
3439
+ * Configurations for API injection.
3440
+ */
3441
+ api: Api;
3591
3442
  /**
3592
3443
  * The name of the view.
3593
3444
  */
@@ -3736,7 +3587,7 @@ declare type ConstWindowOptions = {
3736
3587
  /**
3737
3588
  * @defaultValue true
3738
3589
  *
3739
- * Toggling off would keep the Window alive even if all its Views were closed.
3590
+ * Setting this to false would keep the Window alive even if all its Views were closed.
3740
3591
  * This is meant for advanced users and should be used with caution.
3741
3592
  * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
3742
3593
  * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
@@ -3746,7 +3597,8 @@ declare type ConstWindowOptions = {
3746
3597
  /**
3747
3598
  * @defaultValue 'all'
3748
3599
  *
3749
- * Determines which views prevent close if `closeOnLastViewRemoved` is set to true. Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3600
+ * When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
3601
+ + * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3750
3602
  * **NOTE:** - This option is ignored in non-Platforms apps.
3751
3603
  */
3752
3604
  viewsPreventingClose: 'all' | 'layout';
@@ -4553,7 +4405,7 @@ declare type CreateViewPayload = {
4553
4405
  /**
4554
4406
  * @interface
4555
4407
  */
4556
- declare type CreateViewTarget = LayoutIdentity & {
4408
+ declare type CreateViewTarget = (Identity_5 | LayoutIdentity) & {
4557
4409
  /**
4558
4410
  * If specified, view creation will not attach to a window and caller must
4559
4411
  * insert the view into the layout explicitly
@@ -4693,6 +4545,14 @@ declare type DestroyedEvent = BaseEvent_4 & {
4693
4545
  type: 'destroyed';
4694
4546
  };
4695
4547
 
4548
+ /**
4549
+ * @interface
4550
+ */
4551
+ declare type DeviceInfo = {
4552
+ vendorId: string | number;
4553
+ productId: string | number;
4554
+ };
4555
+
4696
4556
  /**
4697
4557
  * Generated when a page's theme color changes. This is usually due to encountering a meta tag.
4698
4558
  * @interface
@@ -4934,7 +4794,7 @@ declare type DownloadShelfOptions = {
4934
4794
  */
4935
4795
  size?: number;
4936
4796
  /**
4937
- * Color of the border, either a string name or a hex code. Defaults to chromium theme
4797
+ * Color of the border. Must be a 6-character hex code prefixed by #. Defaults to chromium theme
4938
4798
  * if absent.
4939
4799
  */
4940
4800
  color?: string;
@@ -5158,9 +5018,10 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
5158
5018
  } : never;
5159
5019
 
5160
5020
  declare interface Environment {
5161
- initLayout(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, wire: Transport, options: OpenFin_2.InitLayoutOptions): Promise<OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>>;
5021
+ initLayoutManager(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, wire: Transport, options: OpenFin_2.InitLayoutOptions): Promise<OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>>;
5162
5022
  createLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, options: OpenFin_2.CreateLayoutOptions): Promise<void>;
5163
5023
  destroyLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<void>;
5024
+ resolveLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<any>;
5164
5025
  initPlatform(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, ...args: Parameters<OpenFin_2.Fin['Platform']['init']>): ReturnType<OpenFin_2.Fin['Platform']['init']>;
5165
5026
  observeBounds(element: Element, onChange: (bounds: DOMRect) => Promise<void> | void): () => void;
5166
5027
  writeToken(path: string, token: string): Promise<string>;
@@ -5210,7 +5071,7 @@ declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotApplie
5210
5071
  * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
5211
5072
  * from which they propagate).
5212
5073
  */
5213
- declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ViewEvents.PropagatedEvent<'system'> | ApplicationEvents.PropagatedEvent<'system'> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleEvent | MonitorEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
5074
+ declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
5214
5075
 
5215
5076
  /**
5216
5077
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Channel}. Events are
@@ -5382,7 +5243,7 @@ declare type EventType_7 = Event_10['type'];
5382
5243
  /**
5383
5244
  * Union of possible `type` values for a {@link SystemEvent}.
5384
5245
  */
5385
- declare type EventType_8 = SystemEvent['type'];
5246
+ declare type EventType_8 = Event_11['type'];
5386
5247
 
5387
5248
  /**
5388
5249
  * @internal
@@ -5435,83 +5296,6 @@ declare class ExternalApplication extends EmitterBase<OpenFin_2.ExternalApplicat
5435
5296
  * @internal
5436
5297
  */
5437
5298
  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
5299
  /**
5516
5300
  * Retrieves information about the external application.
5517
5301
  *
@@ -5765,7 +5549,7 @@ declare type FileDownloadEvent = {
5765
5549
  *
5766
5550
  * @interface
5767
5551
  */
5768
- declare type FileDownloadLocationChangedEvent = BaseApplicationEvent & {
5552
+ declare type FileDownloadLocationChangedEvent = BaseEvent_3 & {
5769
5553
  type: 'file-download-location-changed';
5770
5554
  };
5771
5555
 
@@ -5930,83 +5714,6 @@ declare class _Frame extends EmitterBase<OpenFin_2.FrameEvent> {
5930
5714
  * @internal
5931
5715
  */
5932
5716
  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
5717
  /**
6011
5718
  * Returns a frame info object for the represented frame.
6012
5719
  *
@@ -6781,6 +6488,11 @@ declare type IdentityEvent = BaseEvent & {
6781
6488
  */
6782
6489
  declare type IdEventType = WithId<AppVersionEventType>;
6783
6490
 
6491
+ /**
6492
+ * @deprecated Renamed to {@link IdleStateChangedEvent}.
6493
+ */
6494
+ declare type IdleEvent = IdleStateChangedEvent;
6495
+
6784
6496
  /**
6785
6497
  * Generated when a user enters or returns from idle state.
6786
6498
  * @remarks This method is continuously generated every minute while the user is in idle.
@@ -6788,7 +6500,7 @@ declare type IdEventType = WithId<AppVersionEventType>;
6788
6500
  * A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
6789
6501
  * @interface
6790
6502
  */
6791
- declare type IdleEvent = BaseEvent_8 & {
6503
+ declare type IdleStateChangedEvent = BaseEvent_8 & {
6792
6504
  type: 'idle-state-changed';
6793
6505
  elapsedTime: number;
6794
6506
  isIdle: boolean;
@@ -7285,56 +6997,6 @@ declare class InteropBroker extends Base {
7285
6997
  static createClosedConstructor(...args: ConstructorParameters<typeof InteropBroker>): {
7286
6998
  new (): InteropBroker;
7287
6999
  };
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
7000
  /**
7339
7001
  * Sets a context for the context group of the incoming current entity.
7340
7002
  * @param setContextOptions - New context to set.
@@ -7578,7 +7240,7 @@ declare class InteropBroker extends Base {
7578
7240
  * // }
7579
7241
  * ```
7580
7242
  *
7581
- * More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/IntentResolution).
7243
+ * More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/Metadata#intentresolution).
7582
7244
  *
7583
7245
  * @param contextForIntent Data passed between entities and applications.
7584
7246
  * @param clientIdentity Identity of the Client making the request.
@@ -7834,95 +7496,6 @@ declare type InteropBrokerOptions = {
7834
7496
  logging?: InteropLoggingOptions;
7835
7497
  };
7836
7498
 
7837
- /**
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
7499
  /**
7927
7500
  * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}
7928
7501
  *
@@ -8361,13 +7934,6 @@ declare type InteropLoggingActions = 'beforeAction' | 'afterAction';
8361
7934
  */
8362
7935
  declare type InteropLoggingOptions = Record<InteropLoggingActions, InteropActionLoggingOption>;
8363
7936
 
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
7937
  /**
8372
7938
  * Manages creation of Interop Brokers and Interop Clients. These APIs are called under-the-hood in Platforms.
8373
7939
  *
@@ -8758,7 +8324,7 @@ declare class Layout extends Base {
8758
8324
  * @internal
8759
8325
  */
8760
8326
  init: (options?: OpenFin_2.InitLayoutOptions) => Promise<Layout>;
8761
- identity: OpenFin_2.LayoutIdentity;
8327
+ identity: OpenFin_2.Identity | OpenFin_2.LayoutIdentity;
8762
8328
  private platform;
8763
8329
  wire: Transport;
8764
8330
  /**
@@ -8977,45 +8543,24 @@ declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'r
8977
8543
  */
8978
8544
  declare type LayoutIdentity = Identity_5 & {
8979
8545
  /**
8980
- * The name of the layout an action should be targeted to. When not provided,
8981
- * OpenFin attempts to resolve the instance via visibility checks.
8546
+ * The name of the layout in a given window.
8982
8547
  */
8983
- layoutName?: string;
8548
+ layoutName: string;
8984
8549
  };
8985
8550
 
8986
8551
  /**
8987
- * Generated when a window and all of its layout's views have either finished or failed navigation.
8552
+ * Generated when the window is created, and all of its layout's views have either finished or failed
8553
+ * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
8988
8554
  * @interface
8989
8555
  */
8990
8556
  declare type LayoutInitializedEvent = BaseEvent_5 & {
8991
8557
  type: 'layout-initialized';
8558
+ layoutIdentity: OpenFin_2.LayoutIdentity;
8992
8559
  ofViews: (OpenFin_2.Identity & {
8993
8560
  entityType: 'view';
8994
8561
  })[];
8995
8562
  };
8996
8563
 
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
8564
  /**
9020
8565
  * Represents the arrangement of Views within a Platform window's Layout. We do not recommend trying
9021
8566
  * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot}.
@@ -9043,7 +8588,7 @@ declare type LayoutItemConfig = {
9043
8588
  *
9044
8589
  * **NOTE**: Internal use only. This type is reserved for Workspace Browser implementation.
9045
8590
  *
9046
- * Responsible for aggergating all layout snapshots and storing LayoutInstances
8591
+ * Responsible for aggregating all layout snapshots and storing layout instances
9047
8592
  */
9048
8593
  declare interface LayoutManager<T extends LayoutSnapshot> {
9049
8594
  /**
@@ -9067,16 +8612,6 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
9067
8612
  * @throws if Object.keys(snapshot).length > 1
9068
8613
  */
9069
8614
  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
8615
  /**
9081
8616
  * @experimental
9082
8617
  *
@@ -9097,31 +8632,49 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
9097
8632
  /**
9098
8633
  * @experimental
9099
8634
  *
9100
- * @param layoutIdentity
9101
- * @returns
8635
+ * A hook provided to the consumer for controlling how OpenFin routes Layout API calls. Override
8636
+ * this method to control the target layout for Layout API calls.
8637
+ *
8638
+ * Example use case: You have hidden all the layouts and are showing a dialog that will
8639
+ * execute an API call (ex: Layout.replace()) - override this method and save the
8640
+ * "last visible" layout identity and return it.
8641
+ *
8642
+ * By default, OpenFin will use a series of checks to determine which Layout the API
8643
+ * call must route to in this order of precedence:
8644
+ * - try to resolve the layout from the layoutIdentity, throws if missing
8645
+ * - if there is only 1 layout, resolves that one
8646
+ * - enumerates all layouts checks visibility via element offsetTop/Left + window.innerHeight/Width
8647
+ * - returns undefined
8648
+ *
8649
+ * @param identity
8650
+ * @returns LayoutIdentity | undefined
9102
8651
  */
9103
- resolveLayout(layoutIdentity?: LayoutIdentity): Promise<LayoutInstance>;
8652
+ resolveLayoutIdentity(identity?: Identity_5 | LayoutIdentity): LayoutIdentity | undefined;
9104
8653
  /**
9105
8654
  * @experimental
9106
8655
  *
9107
- * Returns a LayoutInstance if one exists with the name layoutIdentity.layoutName.
9108
- * Throws if it does not exist.
9109
- * @param layoutName
9110
- * @returns
8656
+ * A hook provided to the consumer when it's time to remove a layout. Use this hook to
8657
+ * update your local state and remove the layout for the given LayoutIdentity. Note that
8658
+ * this hook does not call `fin.Platform.Layout.destroy()` for you, instead it is to
8659
+ * signify to your application it's time to destroy this layout.
8660
+ *
8661
+ * 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.
8662
+ *
8663
+ * @param LayoutIdentity
9111
8664
  */
9112
- getLayoutByName(layoutName: string): LayoutInstance;
8665
+ removeLayout({ layoutName }: LayoutIdentity): Promise<void>;
9113
8666
  /**
9114
8667
  * @experimental
9115
8668
  */
9116
- getLayouts(): Record<string, LayoutInstance>;
8669
+ getLayoutIdentityForView(viewIdentity: Identity_5): LayoutIdentity;
9117
8670
  /**
9118
8671
  * @experimental
9119
8672
  */
9120
- getLayoutIdentityForView(viewIdentity: Identity_5): LayoutIdentity;
8673
+ isLayoutVisible({ layoutName }: LayoutIdentity): boolean;
9121
8674
  /**
9122
8675
  * @experimental
9123
8676
  */
9124
- isLayoutVisible({ layoutName }: LayoutIdentity): boolean;
8677
+ size(): number;
9125
8678
  }
9126
8679
 
9127
8680
  /**
@@ -9168,7 +8721,7 @@ declare class LayoutModule extends Base {
9168
8721
  * const layoutConfig = await layout.getConfig();
9169
8722
  * ```
9170
8723
  */
9171
- wrap(identity: OpenFin_2.LayoutIdentity): Promise<OpenFin_2.Layout>;
8724
+ wrap(identity: OpenFin_2.Identity | OpenFin_2.LayoutIdentity): Promise<OpenFin_2.Layout>;
9172
8725
  /**
9173
8726
  * Synchronously returns a Layout object that represents a Window's layout.
9174
8727
  *
@@ -9188,7 +8741,7 @@ declare class LayoutModule extends Base {
9188
8741
  * const layoutConfig = await layout.getConfig();
9189
8742
  * ```
9190
8743
  */
9191
- wrapSync(identity: OpenFin_2.LayoutIdentity): OpenFin_2.Layout;
8744
+ wrapSync(identity: OpenFin_2.Identity | OpenFin_2.LayoutIdentity): OpenFin_2.Layout;
9192
8745
  /**
9193
8746
  * Asynchronously returns a Layout object that represents a Window's layout.
9194
8747
  *
@@ -9360,6 +8913,15 @@ declare abstract class LayoutNode {
9360
8913
  /**
9361
8914
  * Creates a new TabStack adjacent to the given TabStack or ColumnOrRow. Inputs can be new views to create, or existing views.
9362
8915
  *
8916
+ * Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
8917
+ * during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
8918
+ * This means the views you pass to createAdjacentStack() may not render in the order given by the array.
8919
+ * Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
8920
+ *
8921
+ * @param views The views that will populate the new TabStack.
8922
+ * @param options Additional options that control new TabStack creation.
8923
+ * @returns The newly-created TabStack.
8924
+ *
9363
8925
  * @example
9364
8926
  * ```js
9365
8927
  * if (!fin.me.isView) {
@@ -9394,12 +8956,15 @@ declare abstract class LayoutNode {
9394
8956
  * console.log(`A new TabStack created to the right has ${newStack.length} views in it`);
9395
8957
  *
9396
8958
  * ```
8959
+ * @experimental
9397
8960
  */
9398
8961
  createAdjacentStack: (views: OpenFin_2.PlatformViewCreationOptions[], options: {
9399
8962
  position?: OpenFin_2.LayoutPosition;
9400
8963
  }) => Promise<TabStack>;
9401
8964
  /**
9402
- * Retrieves the adjacent TabStacks of the given TabStack or ColumnOrRow
8965
+ * Retrieves the adjacent TabStacks of the given TabStack or ColumnOrRow.
8966
+ *
8967
+ * @param edge Edge whose adjacent TabStacks will be returned.
9403
8968
  *
9404
8969
  * @example
9405
8970
  * ```js
@@ -9419,6 +8984,7 @@ declare abstract class LayoutNode {
9419
8984
  * console.log(`The entity has ${rightStacks.length} stacks to the right, and ${leftStacks.length} stacks to the left`);
9420
8985
  *
9421
8986
  * ```
8987
+ * @experimental
9422
8988
  */
9423
8989
  getAdjacentStacks: (edge: OpenFin_2.LayoutPosition) => Promise<TabStack[]>;
9424
8990
  }
@@ -9442,7 +9008,7 @@ declare type LayoutOptions = {
9442
9008
  * @defaultValue false
9443
9009
  *
9444
9010
  * Limits the area to which tabs can be dragged.
9445
- * If true, stack headers are the only areas where tabs can be dropped.
9011
+ * If true, the layout container is the only area where tabs can be dropped.
9446
9012
  */
9447
9013
  constrainDragToContainer?: boolean;
9448
9014
  /**
@@ -9513,6 +9079,9 @@ declare type LayoutOptions = {
9513
9079
  };
9514
9080
  };
9515
9081
 
9082
+ /**
9083
+ * Represents the position of an item in a layout relative to another.
9084
+ */
9516
9085
  declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
9517
9086
 
9518
9087
  /**
@@ -9521,11 +9090,12 @@ declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
9521
9090
  declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
9522
9091
 
9523
9092
  /**
9524
- * Generated when a window and all of its layout's views have been created and can receive API calls.
9093
+ * Generated when the layout and all of the its views have been created and can receive API calls.
9525
9094
  * @interface
9526
9095
  */
9527
9096
  declare type LayoutReadyEvent = BaseEvent_5 & {
9528
9097
  type: 'layout-ready';
9098
+ layoutIdentity: OpenFin_2.LayoutIdentity;
9529
9099
  views: (OpenFin_2.Identity & {
9530
9100
  success: boolean;
9531
9101
  })[];
@@ -9872,14 +9442,9 @@ declare type MonitorDetails = {
9872
9442
  };
9873
9443
 
9874
9444
  /**
9875
- * Generated on changes of a monitor's size/location.
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
9445
+ * @deprecated Renamed to {@link MonitorInfoChangedEvent}.
9879
9446
  */
9880
- declare type MonitorEvent = BaseEvent_8 & OpenFin_2.MonitorInfo & {
9881
- type: 'monitor-info-changed';
9882
- };
9447
+ declare type MonitorEvent = MonitorInfoChangedEvent;
9883
9448
 
9884
9449
  /**
9885
9450
  * @interface
@@ -9903,6 +9468,16 @@ declare type MonitorInfo = {
9903
9468
  virtualScreen: DipRect;
9904
9469
  };
9905
9470
 
9471
+ /**
9472
+ * Generated on changes of a monitor's size/location.
9473
+ * @remarks A monitor's size changes when the taskbar is resized or relocated.
9474
+ * The available space of a monitor defines a rectangle that is not occupied by the taskbar
9475
+ * @interface
9476
+ */
9477
+ declare type MonitorInfoChangedEvent = BaseEvent_8 & OpenFin_2.MonitorInfo & {
9478
+ type: 'monitor-info-changed';
9479
+ };
9480
+
9906
9481
  /**
9907
9482
  * @interface
9908
9483
  */
@@ -10233,7 +9808,7 @@ declare type MutableWindowOptions = {
10233
9808
  * Used by Workspace to store custom data. Overwriting or modifying this field may impact the functionality of Workspace
10234
9809
  */
10235
9810
  _internalWorkspaceData: any;
10236
- workspacePlatform: WorkspacePlatformOptions;
9811
+ workspacePlatform: unknown;
10237
9812
  };
10238
9813
 
10239
9814
  declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;
@@ -10319,7 +9894,7 @@ declare type NotCloseRequested<EventType extends string> = Exclude<EventType, 'c
10319
9894
  *
10320
9895
  * Ensures that an event type key doesn't include any `-requested` events. Distributes over unions.
10321
9896
  */
10322
- declare type NotRequested<EventType extends String> = EventType extends `${infer U}-requested` ? never : EventType;
9897
+ declare type NotRequested<EventType extends String> = EventType extends `${string}-requested` ? never : EventType;
10323
9898
 
10324
9899
  /**
10325
9900
  * Generated when an application is not responding.
@@ -10476,6 +10051,7 @@ declare namespace OpenFin_2 {
10476
10051
  WebPermission,
10477
10052
  VerboseWebPermission,
10478
10053
  OpenExternalPermission,
10054
+ DeviceInfo,
10479
10055
  Permissions_2 as Permissions,
10480
10056
  PlatformWindowCreationOptions,
10481
10057
  PlatformWindowOptions,
@@ -10633,7 +10209,6 @@ declare namespace OpenFin_2 {
10633
10209
  InitLayoutOptions,
10634
10210
  LayoutManagerConstructor,
10635
10211
  LayoutManagerOverride,
10636
- LayoutInstance,
10637
10212
  LayoutManager,
10638
10213
  CreateLayoutOptions,
10639
10214
  PresetLayoutOptions_2 as PresetLayoutOptions,
@@ -10825,6 +10400,7 @@ declare type Permissions_2 = {
10825
10400
  Application?: Partial<ApplicationPermissions>;
10826
10401
  System?: Partial<SystemPermissions>;
10827
10402
  webAPIs?: WebPermission[];
10403
+ devices?: DeviceInfo[];
10828
10404
  };
10829
10405
 
10830
10406
  declare type PermissionState_2 = 'granted' | 'denied' | 'unavailable';
@@ -11780,21 +11356,16 @@ declare interface PlatformProvider {
11780
11356
  */
11781
11357
  getInitialLayoutSnapshot(payload: undefined, callerIdentity: OpenFin_2.Identity): Promise<OpenFin_2.LayoutSnapshot | undefined>;
11782
11358
  /**
11783
- * @experimental @internal
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
11359
+ * @experimental
11789
11360
  *
11790
- * @param payload
11361
+ * This API is called during the {@link PlatformProvider.getSnapshot()} call.
11362
+ * Gets the current state of a particular window and its views and returns an object that
11363
+ * can be added to the {@link OpenFin.Snapshot.windows} property. Override this function if
11364
+ * you wish to mutate each window snapshot during the {@link PlatformProvider.getSnapshot()} call
11365
+ * @param identity
11791
11366
  * @param callerIdentity
11792
- * @returns an array of promises
11793
11367
  */
11794
- createViewsForLayout(payload: {
11795
- layout: GoldenLayout.Config;
11796
- target?: OpenFin_2.Identity;
11797
- }, callerIdentity: OpenFin_2.Identity): Promise<OpenFin_2.View>[];
11368
+ getWindowSnapshot(identity: OpenFin_2.Identity, callerIdentity: OpenFin_2.Identity): Promise<OpenFin_2.WindowCreationOptions>;
11798
11369
  /**
11799
11370
  * **NOTE**: Internal use only. It is not recommended to manage the state of individual views.
11800
11371
  * 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 +12829,7 @@ declare type ReplaceLayoutPayload = {
13258
12829
  /**
13259
12830
  * Identity of the window whose layout will be replaced.
13260
12831
  */
13261
- target: LayoutIdentity;
12832
+ target: Identity_5 | LayoutIdentity;
13262
12833
  };
13263
12834
 
13264
12835
  /**
@@ -14096,97 +13667,20 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
14096
13667
  constructor(wire: Transport);
14097
13668
  private sendExternalProcessRequest;
14098
13669
  /**
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.
13670
+ * Returns the version of the runtime. The version contains the major, minor,
13671
+ * build and revision numbers.
14103
13672
  *
14104
- * @function addListener
14105
- * @memberof System
14106
- * @instance
14107
- * @tutorial System.EventEmitter
13673
+ * @example
13674
+ * ```js
13675
+ * fin.System.getVersion().then(v => console.log(v)).catch(err => console.log(err));
13676
+ * ```
14108
13677
  */
13678
+ getVersion(): Promise<string>;
14109
13679
  /**
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
- /**
14176
- * Returns the version of the runtime. The version contains the major, minor,
14177
- * build and revision numbers.
14178
- *
14179
- * @example
14180
- * ```js
14181
- * fin.System.getVersion().then(v => console.log(v)).catch(err => console.log(err));
14182
- * ```
14183
- */
14184
- getVersion(): Promise<string>;
14185
- /**
14186
- * Clears cached data containing application resource
14187
- * files (images, HTML, JavaScript files), cookies, and items stored in the
14188
- * Local Storage.
14189
- * @param options - See below for details.
13680
+ * Clears cached data containing application resource
13681
+ * files (images, HTML, JavaScript files), cookies, and items stored in the
13682
+ * Local Storage.
13683
+ * @param options - See below for details.
14190
13684
  *
14191
13685
  * @remarks For more information on the accepted options, see the following pages:
14192
13686
  * * cache: browsing data cache for html files and images ([caching](https://developer.mozilla.org/en-US/docs/Web/HTTP/Caching))
@@ -15615,7 +15109,9 @@ declare namespace SystemEvents {
15615
15109
  NotRequested,
15616
15110
  ExcludeRequested,
15617
15111
  BaseEvent_8 as BaseEvent,
15112
+ IdleStateChangedEvent,
15618
15113
  IdleEvent,
15114
+ MonitorInfoChangedEvent,
15619
15115
  MonitorEvent,
15620
15116
  SessionChangedEvent,
15621
15117
  AppVersionEvent,
@@ -15759,75 +15255,11 @@ declare interface TabDragListener extends EventEmitter_2 {
15759
15255
  contentItem: ContentItem;
15760
15256
  }
15761
15257
 
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
15258
  /**
15777
15259
  * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
15778
15260
  */
15779
15261
  declare class TabStack extends LayoutNode {
15780
15262
  #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
15263
  /** @internal */
15832
15264
  constructor(client: LayoutEntitiesClient, entityId: string);
15833
15265
  /**
@@ -16268,169 +15700,6 @@ declare type VerboseWebPermission = {
16268
15700
 
16269
15701
  declare type View = OpenFin_2.View;
16270
15702
 
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
15703
  /**
16435
15704
  * A View can be used to embed additional web content into a Window.
16436
15705
  * It is like a child window, except it is positioned relative to its owning window.
@@ -16946,7 +16215,7 @@ declare type ViewCreationOrReference = OpenFin_2.Identity | OpenFin_2.PlatformVi
16946
16215
  */
16947
16216
  declare type ViewDetachedEvent = BaseEvent_5 & {
16948
16217
  type: 'view-detached';
16949
- target: OpenFin_2.Identity;
16218
+ target: OpenFin_2.Identity | null;
16950
16219
  previousTarget: OpenFin_2.Identity;
16951
16220
  viewIdentity: OpenFin_2.Identity;
16952
16221
  };
@@ -18182,7 +17451,7 @@ declare namespace WebContentsEvents {
18182
17451
  * `clipboard-read`: Request access to read from the clipboard.<br>
18183
17452
  * `clipboard-sanitized-write`: Request access to write to the clipboard.
18184
17453
  */
18185
- declare type WebPermission = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write' | OpenExternalPermission;
17454
+ declare type WebPermission = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write' | 'hid' | 'usb' | OpenExternalPermission;
18186
17455
 
18187
17456
  /**
18188
17457
  * Object representing headers and their values, where the
@@ -18260,476 +17529,6 @@ declare type WillResizeEvent = WillMoveOrResizeEvent & {
18260
17529
  type: 'will-resize';
18261
17530
  };
18262
17531
 
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
17532
  /**
18734
17533
  * A basic window that wraps a native HTML window. Provides more fine-grained
18735
17534
  * control over the window state such as the ability to minimize, maximize, restore, etc.
@@ -18742,83 +17541,6 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
18742
17541
  * @internal
18743
17542
  */
18744
17543
  constructor(wire: Transport, identity: OpenFin_2.Identity);
18745
- /**
18746
- * Adds a listener to the end of the listeners array for the specified event.
18747
- * @param eventType - The type of the event.
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
18755
- */
18756
- /**
18757
- * Adds a listener to the end of the listeners array for the specified event.
18758
- * @param eventType - The type of the event.
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
17544
  /**
18823
17545
  * create a new window
18824
17546
  * @internal
@@ -19599,10 +18321,9 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19599
18321
  show(force?: boolean): Promise<void>;
19600
18322
  /**
19601
18323
  * Shows the window if it is hidden at the specified location.
19602
- * If the toggle parameter is set to true, the window will
19603
- * alternate between showing and hiding.
19604
- * @param left The left position of the window
19605
- * @param top The right position of the window
18324
+ *
18325
+ * @param left The left position of the window in pixels
18326
+ * @param top The top position of the window in pixels
19606
18327
  * @param force Show will be prevented from closing when force is false and
19607
18328
  * ‘show-requested’ has been subscribed to for application’s main window
19608
18329
  *
@@ -19664,28 +18385,6 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19664
18385
  * ```
19665
18386
  */
19666
18387
  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
18388
  /**
19690
18389
  * Shows a menu on the window.
19691
18390
  *
@@ -19782,590 +18481,565 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19782
18481
  */
19783
18482
  closePopupMenu(): Promise<void>;
19784
18483
  /**
19785
- * @PORTED
19786
- * @typedef {object} PopupOptions@typedef {object} PopupOptions
19787
- * @property {string} [name] - If a window with this `name` exists, it will be shown as a popup. Otherwise, a new window with this `name` will be created. If this `name` is undefined, `initialOptions.name` will be used. If this `name` and `intialOptions.name` are both undefined, a `name` will be generated.
19788
- * @property {string} [url] - Navigates to this `url` if showing an existing window as a popup, otherwise the newly created window will load this `url`.
19789
- * @property {Window~options} [initialOptions] - Window creation options when using `showPopupWindow` to create a new window.
19790
- * @property {Window~options} [additionalOptions] - Updatable window options applied to new and existing windows when shown as popups.
19791
- * @property {function} [onPopupResult] - Executed when this window's popup calls `dispatchPopupResult`. Note: if this is defined, `showPopupWindow` will not return a `PopupResult`.
19792
- * @property {function} [onPopupReady] - Executed when the popup window is shown. Provides the popup window to the provided function, and allows for easy access the popup window for additional behavior customization.
19793
- * @property {number} [height] - Height of the popup window (takes priority over `intialOptions` size properties).
19794
- * @property {number} [width] - Width of the popup window (takes priority over `intialOptions` size properties).
19795
- * @property {number} [x] - Left position where the popup window will be shown (relative to the window calling `showPopupWindow`).
19796
- * @property {number} [y] - Top position where the popup window will be shown (relative to the window calling `showPopupWindow`).
19797
- * @property {'modal' | 'hide' | 'close'} [blurBehavior] - Determines what happens if the popup window is blurred. 'modal' restricts resizing and positioning in the caller, 'hide' hides the popup window on blur and 'close' closes the popup window on blur.
19798
- * @property {'none' | 'hide' | 'close'} [resultDispatchBehavior] - Determines what happens when the popup window calls `dispatchPopupResult`. 'none' will do nothing, 'hide' hides the popup window on `dispatchPopupResult` and 'close' closes the popup window on `dispatchPopupResult`.
19799
- * @property {boolean} [focus] - Determines if the popup window should or should not be focused when it is shown.
19800
- * @property {boolean} [hideOnClose] - Hide the popup window instead of closing whenever `close` is called on it. Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
19801
- */
19802
- /**
19803
- * @PORTED
19804
- * @typedef {object} PopupResult@typedef {object} PopupResult
19805
- * @property {Identity} identity - `name` and `uuid` of the popup window that called dispatched this result.
19806
- * @property {'clicked' | 'dismissed'} result - Result of the user interaction with the popup window.
19807
- * @property {* | undefined} [data] - Data passed to `dispatchPopupResult`.
19808
- */
19809
- /**
19810
- * Dispatch a result to the caller of `showPopupWindow`.
19811
- *
19812
- * @remarks If this window isn't currently being shown as a popup, this call will silently fail.
19813
- * @param data Serializable data to send to the caller window.
19814
- *
19815
- * @example
19816
- * ```js
19817
- * await fin.me.dispatchPopupResult({
19818
- * foo: 'bar'
19819
- * });
19820
- * ```
19821
- */
19822
- dispatchPopupResult(data: any): Promise<void>;
19823
- /**
19824
- * Prints the contents of the window.
19825
- *
19826
- * @param options Configuration for the print task.
19827
- * @remarks When `silent` is set to `true`, the API will pick the system's default printer if deviceName is empty
19828
- * and the default settings for printing.
19829
- *
19830
- * Use the CSS style `page-break-before: always;` to force print to a new page.
19831
- *
19832
- * @example
19833
- * ```js
19834
- * const win = fin.Window.getCurrentSync();
19835
- *
19836
- * win.print({ silent: false, deviceName: 'system-printer-name' }).then(() => {
19837
- * console.log('print call has been sent to the system');
19838
- * });
19839
- * ```
19840
- *
19841
- * If a window has embedded views, those views will not print by default. To print a window's contents including embedded views,
19842
- * use the `content` option:
19843
- *
19844
- * ```js
19845
- * const win = fin.Window.getCurrentSync();
19846
- *
19847
- * // Print embedded views
19848
- * win.print({ content: 'views' });
19849
- *
19850
- * // Print screenshot of current window
19851
- * win.print({ content: 'screenshot' })
19852
- * ```
19853
- *
19854
- * When `content` is set to `views`, the embedded views in the platform window will be concatenated and printed as
19855
- * individual pages. If `includeSelf` is set to `true`, the platform window itself will be printed as the first
19856
- * page - be aware that this page will *not* include the embedded views - it will only include the contents of
19857
- * the platform window itself (e.g. tab stacks), with blank spaces where the view contents would be embedded.
19858
- *
19859
- * Due to a known issue, view contents that are not visible at the time `print` is called will not appear when
19860
- * printing `contents: views`. This includes views that are obscured behind other active UI elements.
19861
- *
19862
- * To print the views embedded in their page context, set `content` to `screenshot`.
19863
- */
19864
- print(options?: OpenFin_2.WindowPrintOptions): Promise<void>;
19865
- }
19866
-
19867
- /**
19868
- * Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
19869
- * @interface
19870
- */
19871
- declare type WindowAlertRequestedEvent = BaseApplicationEvent & {
19872
- type: 'window-alert-requested';
19873
- };
19874
-
19875
- /**
19876
- * Returned from getBounds call. bottom and right are never used for setting.
19877
- * @interface
19878
- */
19879
- declare type WindowBounds = Bounds & {
19880
- bottom: number;
19881
- right: number;
19882
- };
19883
-
19884
- /**
19885
- * @deprecated Renamed to {@link ClosedEvent}.
19886
- */
19887
- declare type WindowClosedEvent = ClosedEvent_2;
19888
-
19889
- /**
19890
- * @deprecated Renamed to {@link CloseRequestedEvent}.
19891
- */
19892
- declare type WindowCloseRequestedEvent = CloseRequestedEvent;
19893
-
19894
- /**
19895
- * @deprecated Renamed to {@link ClosingEvent}.
19896
- */
19897
- declare type WindowClosingEvent = ClosingEvent;
19898
-
19899
- /**
19900
- * A rule prescribing content creation in a {@link OpenFin.Window}.
19901
- *
19902
- * @interface
19903
- */
19904
- declare type WindowContentCreationRule = BaseContentCreationRule & {
19905
- /**
19906
- * Behavior to use when opening matched content.
19907
- */
19908
- behavior: 'window';
19909
- /**
19910
- * Options for newly-created window.
19911
- */
19912
- options?: Partial<WindowOptions>;
19913
- };
19914
-
19915
- /**
19916
- * Generated when a child window is created.
19917
- * @interface
19918
- */
19919
- declare type WindowCreatedEvent = BaseApplicationEvent & {
19920
- type: 'window-created';
19921
- };
19922
-
19923
- /**
19924
- * Options required to create a new window with {@link Window._WindowModule.create Window.create}.
19925
- *
19926
- * Note that `name` is the only required property — albeit the `url` property is usually provided as well
19927
- * (defaults to `"about:blank"` when omitted).
19928
- * @interface
19929
- */
19930
- declare type WindowCreationOptions = Partial<WindowOptions> & {
19931
- name: string;
19932
- };
19933
-
19934
- declare type WindowCreationReason = 'tearout' | 'create-view-without-target' | 'api-call' | 'app-creation' | 'restore' | 'apply-snapshot';
19935
-
19936
- /**
19937
- * @interface
19938
- */
19939
- declare type WindowDetail = {
19940
- /**
19941
- * The bottom-most coordinate of the window.
19942
- */
19943
- bottom: number;
19944
- /**
19945
- * The height of the window.
19946
- */
19947
- height: number;
19948
- isShowing: boolean;
19949
- /**
19950
- * The left-most coordinate of the window.
19951
- */
19952
- left: number;
19953
- /**
19954
- * The name of the window.
19955
- */
19956
- name: string;
19957
- /**
19958
- * The right-most coordinate of the window.
19959
- */
19960
- right: number;
19961
- state: string;
19962
- /**
19963
- * The top-most coordinate of the window.
19964
- */
19965
- top: number;
19966
- /**
19967
- * The width of the window.
19968
- */
19969
- width: number;
19970
- };
19971
-
19972
- /**
19973
- * Generated when a child window ends loading.
19974
- * @interface
19975
- */
19976
- declare type WindowEndLoadEvent = BaseApplicationEvent & {
19977
- type: 'window-end-load';
19978
- };
19979
-
19980
- /**
19981
- * @deprecated, Renamed to {@link Event}.
19982
- */
19983
- declare type WindowEvent = Event_6;
19984
-
19985
- declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
19986
-
19987
- declare namespace WindowEvents {
19988
- export {
19989
- BaseEvent_5 as BaseEvent,
19990
- BaseWindowEvent,
19991
- ViewAttachedEvent,
19992
- ViewDetachedEvent,
19993
- WindowViewEvent,
19994
- AlertRequestedEvent,
19995
- AuthRequestedEvent,
19996
- EndLoadEvent,
19997
- WillRedirectEvent,
19998
- ReloadedEvent,
19999
- OptionsChangedEvent,
20000
- WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
20001
- ExternalProcessExitedEvent,
20002
- ExternalProcessStartedEvent,
20003
- HiddenEvent_2 as HiddenEvent,
20004
- WindowHiddenEvent,
20005
- PreloadScriptInfoRunning,
20006
- PreloadScriptInfo,
20007
- PreloadScriptsStateChangeEvent,
20008
- UserBoundsChangeEvent,
20009
- BoundsChangeEvent,
20010
- WillMoveOrResizeEvent,
20011
- PerformanceReportEvent,
20012
- InputEvent_2 as InputEvent,
20013
- LayoutInitializedEvent,
20014
- LayoutReadyEvent,
20015
- BeginUserBoundsChangingEvent,
20016
- BoundsChangedEvent,
20017
- BoundsChangingEvent,
20018
- CloseRequestedEvent,
20019
- WindowCloseRequestedEvent,
20020
- ContextChangedEvent,
20021
- ClosedEvent_2 as ClosedEvent,
20022
- WindowClosedEvent,
20023
- ClosingEvent,
20024
- WindowClosingEvent,
20025
- DisabledMovementBoundsChangedEvent,
20026
- DisabledMovementBoundsChangingEvent,
20027
- EmbeddedEvent,
20028
- EndUserBoundsChangingEvent,
20029
- HotkeyEvent_2 as HotkeyEvent,
20030
- WindowHotkeyEvent,
20031
- InitializedEvent_2 as InitializedEvent,
20032
- WindowInitializedEvent,
20033
- MaximizedEvent,
20034
- MinimizedEvent,
20035
- PreloadScriptsStateChangedEvent,
20036
- PreloadScriptsStateChangingEvent,
20037
- RestoredEvent,
20038
- WindowRestoredEvent,
20039
- ShowRequestedEvent,
20040
- WindowShowRequestedEvent,
20041
- ShownEvent_2 as ShownEvent,
20042
- WindowShownEvent,
20043
- UserMovementEnabledEvent,
20044
- UserMovementDisabledEvent,
20045
- WillMoveEvent,
20046
- WillResizeEvent,
20047
- NonPropagatedWindowEvent,
20048
- ShowAllDownloadsEvent,
20049
- DownloadShelfVisibilityChangedEvent,
20050
- WindowSourcedEvent,
20051
- WillPropagateWindowEvent,
20052
- Event_6 as Event,
20053
- WindowEvent,
20054
- EventType_2 as EventType,
20055
- WindowEventType,
20056
- PropagatedEvent_3 as PropagatedEvent,
20057
- PropagatedWindowEvent,
20058
- PropagatedWindowEventType,
20059
- Payload_3 as Payload,
20060
- ByType_2 as ByType
20061
- }
20062
- }
20063
-
20064
- /**
20065
- * @deprecated Renamed to {@link EventType}.
20066
- */
20067
- declare type WindowEventType = WindowEvent['type'];
20068
-
20069
- /**
20070
- * @deprecated Renamed to {@link HiddenEvent}.
20071
- */
20072
- declare type WindowHiddenEvent = HiddenEvent_2;
20073
-
20074
- /**
20075
- * @deprecated Renamed to {@link HotkeyEvent}.
20076
- */
20077
- declare type WindowHotkeyEvent = HotkeyEvent_2;
20078
-
20079
- /**
20080
- * @interface
20081
- */
20082
- declare type WindowInfo = {
20083
- canNavigateBack: boolean;
20084
- canNavigateForward: boolean;
20085
- preloadScripts: Array<any>;
20086
- title: string;
20087
- url: string;
20088
- };
20089
-
20090
- /**
20091
- * @deprecated Renamed to {@link InitializedEvent}.
20092
- */
20093
- declare type WindowInitializedEvent = InitializedEvent_2;
20094
-
20095
- /**
20096
- * Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
20097
- */
20098
- declare class _WindowModule extends Base {
20099
- /**
20100
- * Asynchronously returns a Window object that represents an existing window.
20101
- *
20102
- * @example
20103
- * ```js
20104
- * async function createWin() {
20105
- * const app = await fin.Application.start({
20106
- * name: 'myApp',
20107
- * uuid: 'app-1',
20108
- * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrap.html',
20109
- * autoShow: true
20110
- * });
20111
- * return await app.getWindow();
20112
- * }
20113
- * createWin().then(() => fin.Window.wrap({ uuid: 'app-1', name: 'myApp' }))
20114
- * .then(win => console.log('wrapped window'))
20115
- * .catch(err => console.log(err));
20116
- * ```
20117
- */
20118
- wrap(identity: OpenFin_2.Identity): Promise<OpenFin_2.Window>;
20119
- /**
20120
- * Synchronously returns a Window object that represents an existing window.
20121
- *
20122
- * @example
20123
- * ```js
20124
- * async function createWin() {
20125
- * const app = await fin.Application.start({
20126
- * name: 'myApp',
20127
- * uuid: 'app-1',
20128
- * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrapSync.html',
20129
- * autoShow: true
20130
- * });
20131
- * return await app.getWindow();
20132
- * }
20133
- * await createWin();
20134
- * let win = fin.Window.wrapSync({ uuid: 'app-1', name: 'myApp' });
20135
- * ```
20136
- */
20137
- wrapSync(identity: OpenFin_2.Identity): OpenFin_2.Window;
20138
- /**
20139
- * Creates a new Window.
20140
- * @param options - Window creation options
20141
- *
20142
- * @example
20143
- * ```js
20144
- * async function createWindow() {
20145
- * const winOption = {
20146
- * name:'child',
20147
- * defaultWidth: 300,
20148
- * defaultHeight: 300,
20149
- * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.create.html',
20150
- * frame: true,
20151
- * autoShow: true
20152
- * };
20153
- * return await fin.Window.create(winOption);
20154
- * }
20155
- *
20156
- * createWindow().then(() => console.log('Window is created')).catch(err => console.log(err));
20157
- * ```
20158
- */
20159
- create(options: OpenFin_2.WindowCreationOptions): Promise<OpenFin_2.Window>;
20160
- /**
20161
- * Asynchronously returns a Window object that represents the current window
20162
- *
20163
- * @example
20164
- * ```js
20165
- * fin.Window.getCurrent()
20166
- * .then(wnd => console.log('current window'))
20167
- * .catch(err => console.log(err));
20168
- *
20169
- * ```
20170
- */
20171
- getCurrent(): Promise<OpenFin_2.Window>;
20172
- /**
20173
- * Synchronously returns a Window object that represents the current window
20174
- *
20175
- * @example
20176
- * ```js
20177
- * const wnd = fin.Window.getCurrentSync();
20178
- * const info = await wnd.getInfo();
20179
- * console.log(info);
20180
- *
20181
- * ```
20182
- */
20183
- getCurrentSync(): OpenFin_2.Window;
20184
- }
20185
-
20186
- /**
20187
- * Generated when a child window is not responding.
20188
- * @interface
20189
- */
20190
- declare type WindowNotRespondingEvent = BaseApplicationEvent & {
20191
- type: 'window-not-responding';
20192
- };
20193
-
20194
- /**
20195
- * @interface
20196
- */
20197
- declare type WindowOptionDiff = {
20198
- [key in keyof WindowOptions]: {
20199
- oldVal: WindowOptions[key];
20200
- newVal: WindowOptions[key];
20201
- };
20202
- };
20203
-
20204
- /**
20205
- * @interface
20206
- */
20207
- declare type WindowOptions = MutableWindowOptions & ConstWindowOptions;
20208
-
20209
- declare type WindowOptionsChangedEvent = OpenFin_2.WindowEvents.WindowOptionsChangedEvent;
20210
-
20211
- /**
20212
- * @deprecated Renamed to {@link OptionsChangedEvent}.
20213
- */
20214
- declare type WindowOptionsChangedEvent_2 = OptionsChangedEvent;
20215
-
20216
- declare type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
20217
-
20218
- /**
20219
- * Generated when a child window is responding.
20220
- * @interface
20221
- */
20222
- declare type WindowRespondingEvent = BaseApplicationEvent & {
20223
- type: 'window-responding';
20224
- };
20225
-
20226
- /**
20227
- * @deprecated Renamed to {@link RestoredEvent}.
20228
- */
20229
- declare type WindowRestoredEvent = RestoredEvent;
20230
-
20231
- /**
20232
- * @deprecated Renamed to {@link ShownEvent}.
20233
- */
20234
- declare type WindowShownEvent = ShownEvent_2;
20235
-
20236
- /**
20237
- * @deprecated Renamed to {@link ShowRequestedEvent}.
20238
- */
20239
- declare type WindowShowRequestedEvent = ShowRequestedEvent;
20240
-
20241
- /**
20242
- * A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
20243
- * from {@link OpenFin.ViewEvents}.
20244
- */
20245
- 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;
20246
-
20247
- /**
20248
- * Generated when a child window starts loading.
20249
- * @interface
20250
- */
20251
- declare type WindowStartLoadEvent = BaseApplicationEvent & {
20252
- type: 'window-start-load';
20253
- };
20254
-
20255
- /**
20256
- * Visibility state of a window.
20257
- */
20258
- declare type WindowState = 'maximized' | 'minimized' | 'normal';
20259
-
20260
- /**
20261
- * A view-related event that fires natively on the `Window` topic. This means that these events *do* propagate
20262
- * to the `Application` level, with the name pattern `window-view-eventname`.
20263
- */
20264
- declare type WindowViewEvent = {
20265
- viewIdentity: OpenFin_2.Identity;
20266
- } & (ViewAttachedEvent | ViewDetachedEvent);
20267
-
20268
- /**
20269
- * @interface
20270
- */
20271
- declare type WindowViewsPrintOptions = {
20272
- content: 'views';
20273
- includeSelf?: boolean;
20274
- };
20275
-
20276
- declare type Wire = EventEmitter & {
20277
- connect(messageReciever: MessageReceiver): Promise<any>;
20278
- connectSync(): any;
20279
- send(data: any): Promise<any>;
20280
- shutdown(): Promise<void>;
20281
- getPort(): string;
20282
- };
20283
-
20284
- declare type WireConstructor = {
20285
- new (onmessage: (data: any) => void): Wire;
20286
- };
20287
-
20288
- /**
20289
- * @internal
20290
- */
20291
- declare type WithId<T extends AppVersionEventType> = `${T}.${string}`;
20292
-
20293
- declare interface WithInterop {
20294
- interop: InteropClient;
20295
- }
20296
-
20297
- /**
20298
- * @internal
20299
- */
20300
- declare type WithoutId<T extends string> = T extends WithId<infer U> ? U : never;
20301
-
20302
- declare type WithPositioningOptions<T extends {} = {}> = T & {
20303
- positioningOptions?: OpenFin_2.PositioningOptions;
20304
- };
20305
-
20306
- /**
20307
- * @internal
20308
- * @interface
20309
- */
20310
- declare type WorkspacePlatformOptions = {
20311
- /** Leaving this as any for now until we figure out what the shape should look like in Workspace */
20312
- [key: string]: any;
20313
- };
20314
-
20315
- /**
20316
- * A generic request to write any supported data to the clipboard.
20317
- * @interface
20318
- */
20319
- declare type WriteAnyClipboardRequest = BaseClipboardRequest & {
20320
- /**
20321
- * Data to be written
20322
- */
20323
- data: {
20324
- text?: string;
20325
- html?: string;
20326
- rtf?: string;
20327
- } & Partial<Pick<WriteImageClipboardRequest, 'image'>>;
20328
- };
20329
-
20330
- /**
20331
- * @deprecated - instead use WriteAnyClipboardRequest
20332
- *
20333
- * A generic request to write any supported data to the clipboard.
20334
- *
20335
- * @interface
20336
- */
20337
- declare type WriteAnyRequestType = WriteAnyClipboardRequest;
20338
-
20339
- /**
20340
- * A request to write data to the clipboard.
20341
- * @interface
20342
- */
20343
- declare type WriteClipboardRequest = BaseClipboardRequest & {
20344
- /**
20345
- * Data to write to the clipboard.
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 { }
18484
+ * Dispatch a result to the caller of `showPopupWindow`.
18485
+ *
18486
+ * @remarks If this window isn't currently being shown as a popup, this call will silently fail.
18487
+ * @param data Serializable data to send to the caller window.
18488
+ *
18489
+ * @example
18490
+ * ```js
18491
+ * await fin.me.dispatchPopupResult({
18492
+ * foo: 'bar'
18493
+ * });
18494
+ * ```
18495
+ */
18496
+ dispatchPopupResult(data: any): Promise<void>;
18497
+ /**
18498
+ * Prints the contents of the window.
18499
+ *
18500
+ * @param options Configuration for the print task.
18501
+ * @remarks When `silent` is set to `true`, the API will pick the system's default printer if deviceName is empty
18502
+ * and the default settings for printing.
18503
+ *
18504
+ * Use the CSS style `page-break-before: always;` to force print to a new page.
18505
+ *
18506
+ * @example
18507
+ * ```js
18508
+ * const win = fin.Window.getCurrentSync();
18509
+ *
18510
+ * win.print({ silent: false, deviceName: 'system-printer-name' }).then(() => {
18511
+ * console.log('print call has been sent to the system');
18512
+ * });
18513
+ * ```
18514
+ *
18515
+ * If a window has embedded views, those views will not print by default. To print a window's contents including embedded views,
18516
+ * use the `content` option:
18517
+ *
18518
+ * ```js
18519
+ * const win = fin.Window.getCurrentSync();
18520
+ *
18521
+ * // Print embedded views
18522
+ * win.print({ content: 'views' });
18523
+ *
18524
+ * // Print screenshot of current window
18525
+ * win.print({ content: 'screenshot' })
18526
+ * ```
18527
+ *
18528
+ * When `content` is set to `views`, the embedded views in the platform window will be concatenated and printed as
18529
+ * individual pages. If `includeSelf` is set to `true`, the platform window itself will be printed as the first
18530
+ * page - be aware that this page will *not* include the embedded views - it will only include the contents of
18531
+ * the platform window itself (e.g. tab stacks), with blank spaces where the view contents would be embedded.
18532
+ *
18533
+ * Due to a known issue, view contents that are not visible at the time `print` is called will not appear when
18534
+ * printing `contents: views`. This includes views that are obscured behind other active UI elements.
18535
+ *
18536
+ * To print the views embedded in their page context, set `content` to `screenshot`.
18537
+ */
18538
+ print(options?: OpenFin_2.WindowPrintOptions): Promise<void>;
18539
+ }
18540
+
18541
+ /**
18542
+ * Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
18543
+ * @interface
18544
+ */
18545
+ declare type WindowAlertRequestedEvent = BaseEvent_3 & {
18546
+ type: 'window-alert-requested';
18547
+ };
18548
+
18549
+ /**
18550
+ * Returned from getBounds call. bottom and right are never used for setting.
18551
+ * @interface
18552
+ */
18553
+ declare type WindowBounds = Bounds & {
18554
+ bottom: number;
18555
+ right: number;
18556
+ };
18557
+
18558
+ /**
18559
+ * @deprecated Renamed to {@link ClosedEvent}.
18560
+ */
18561
+ declare type WindowClosedEvent = ClosedEvent_2;
18562
+
18563
+ /**
18564
+ * @deprecated Renamed to {@link CloseRequestedEvent}.
18565
+ */
18566
+ declare type WindowCloseRequestedEvent = CloseRequestedEvent;
18567
+
18568
+ /**
18569
+ * @deprecated Renamed to {@link ClosingEvent}.
18570
+ */
18571
+ declare type WindowClosingEvent = ClosingEvent;
18572
+
18573
+ /**
18574
+ * A rule prescribing content creation in a {@link OpenFin.Window}.
18575
+ *
18576
+ * @interface
18577
+ */
18578
+ declare type WindowContentCreationRule = BaseContentCreationRule & {
18579
+ /**
18580
+ * Behavior to use when opening matched content.
18581
+ */
18582
+ behavior: 'window';
18583
+ /**
18584
+ * Options for newly-created window.
18585
+ */
18586
+ options?: Partial<WindowOptions>;
18587
+ };
18588
+
18589
+ /**
18590
+ * Generated when a child window is created.
18591
+ * @interface
18592
+ */
18593
+ declare type WindowCreatedEvent = BaseEvent_3 & {
18594
+ type: 'window-created';
18595
+ };
18596
+
18597
+ /**
18598
+ * Options required to create a new window with {@link Window._WindowModule.create Window.create}.
18599
+ *
18600
+ * Note that `name` is the only required property — albeit the `url` property is usually provided as well
18601
+ * (defaults to `"about:blank"` when omitted).
18602
+ * @interface
18603
+ */
18604
+ declare type WindowCreationOptions = Partial<WindowOptions> & {
18605
+ name: string;
18606
+ };
18607
+
18608
+ declare type WindowCreationReason = 'tearout' | 'create-view-without-target' | 'api-call' | 'app-creation' | 'restore' | 'apply-snapshot';
18609
+
18610
+ /**
18611
+ * @interface
18612
+ */
18613
+ declare type WindowDetail = {
18614
+ /**
18615
+ * The bottom-most coordinate of the window.
18616
+ */
18617
+ bottom: number;
18618
+ /**
18619
+ * The height of the window.
18620
+ */
18621
+ height: number;
18622
+ isShowing: boolean;
18623
+ /**
18624
+ * The left-most coordinate of the window.
18625
+ */
18626
+ left: number;
18627
+ /**
18628
+ * The name of the window.
18629
+ */
18630
+ name: string;
18631
+ /**
18632
+ * The right-most coordinate of the window.
18633
+ */
18634
+ right: number;
18635
+ state: string;
18636
+ /**
18637
+ * The top-most coordinate of the window.
18638
+ */
18639
+ top: number;
18640
+ /**
18641
+ * The width of the window.
18642
+ */
18643
+ width: number;
18644
+ };
18645
+
18646
+ /**
18647
+ * Generated when a child window ends loading.
18648
+ * @interface
18649
+ */
18650
+ declare type WindowEndLoadEvent = BaseEvent_3 & {
18651
+ type: 'window-end-load';
18652
+ };
18653
+
18654
+ /**
18655
+ * @deprecated, Renamed to {@link Event}.
18656
+ */
18657
+ declare type WindowEvent = Event_6;
18658
+
18659
+ declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
18660
+
18661
+ declare namespace WindowEvents {
18662
+ export {
18663
+ BaseEvent_5 as BaseEvent,
18664
+ BaseWindowEvent,
18665
+ ViewAttachedEvent,
18666
+ ViewDetachedEvent,
18667
+ WindowViewEvent,
18668
+ AlertRequestedEvent,
18669
+ AuthRequestedEvent,
18670
+ EndLoadEvent,
18671
+ WillRedirectEvent,
18672
+ ReloadedEvent,
18673
+ OptionsChangedEvent,
18674
+ WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
18675
+ ExternalProcessExitedEvent,
18676
+ ExternalProcessStartedEvent,
18677
+ HiddenEvent_2 as HiddenEvent,
18678
+ WindowHiddenEvent,
18679
+ PreloadScriptInfoRunning,
18680
+ PreloadScriptInfo,
18681
+ PreloadScriptsStateChangeEvent,
18682
+ UserBoundsChangeEvent,
18683
+ BoundsChangeEvent,
18684
+ WillMoveOrResizeEvent,
18685
+ PerformanceReportEvent,
18686
+ InputEvent_2 as InputEvent,
18687
+ LayoutInitializedEvent,
18688
+ LayoutReadyEvent,
18689
+ BeginUserBoundsChangingEvent,
18690
+ BoundsChangedEvent,
18691
+ BoundsChangingEvent,
18692
+ CloseRequestedEvent,
18693
+ WindowCloseRequestedEvent,
18694
+ ContextChangedEvent,
18695
+ ClosedEvent_2 as ClosedEvent,
18696
+ WindowClosedEvent,
18697
+ ClosingEvent,
18698
+ WindowClosingEvent,
18699
+ DisabledMovementBoundsChangedEvent,
18700
+ DisabledMovementBoundsChangingEvent,
18701
+ EmbeddedEvent,
18702
+ EndUserBoundsChangingEvent,
18703
+ HotkeyEvent_2 as HotkeyEvent,
18704
+ WindowHotkeyEvent,
18705
+ InitializedEvent_2 as InitializedEvent,
18706
+ WindowInitializedEvent,
18707
+ MaximizedEvent,
18708
+ MinimizedEvent,
18709
+ PreloadScriptsStateChangedEvent,
18710
+ PreloadScriptsStateChangingEvent,
18711
+ RestoredEvent,
18712
+ WindowRestoredEvent,
18713
+ ShowRequestedEvent,
18714
+ WindowShowRequestedEvent,
18715
+ ShownEvent_2 as ShownEvent,
18716
+ WindowShownEvent,
18717
+ UserMovementEnabledEvent,
18718
+ UserMovementDisabledEvent,
18719
+ WillMoveEvent,
18720
+ WillResizeEvent,
18721
+ NonPropagatedWindowEvent,
18722
+ ShowAllDownloadsEvent,
18723
+ DownloadShelfVisibilityChangedEvent,
18724
+ WindowSourcedEvent,
18725
+ WillPropagateWindowEvent,
18726
+ Event_6 as Event,
18727
+ WindowEvent,
18728
+ EventType_2 as EventType,
18729
+ WindowEventType,
18730
+ PropagatedEvent_3 as PropagatedEvent,
18731
+ PropagatedWindowEvent,
18732
+ PropagatedWindowEventType,
18733
+ Payload_3 as Payload,
18734
+ ByType_2 as ByType
18735
+ }
18736
+ }
18737
+
18738
+ /**
18739
+ * @deprecated Renamed to {@link EventType}.
18740
+ */
18741
+ declare type WindowEventType = WindowEvent['type'];
18742
+
18743
+ /**
18744
+ * @deprecated Renamed to {@link HiddenEvent}.
18745
+ */
18746
+ declare type WindowHiddenEvent = HiddenEvent_2;
18747
+
18748
+ /**
18749
+ * @deprecated Renamed to {@link HotkeyEvent}.
18750
+ */
18751
+ declare type WindowHotkeyEvent = HotkeyEvent_2;
18752
+
18753
+ /**
18754
+ * @interface
18755
+ */
18756
+ declare type WindowInfo = {
18757
+ canNavigateBack: boolean;
18758
+ canNavigateForward: boolean;
18759
+ preloadScripts: Array<any>;
18760
+ title: string;
18761
+ url: string;
18762
+ };
18763
+
18764
+ /**
18765
+ * @deprecated Renamed to {@link InitializedEvent}.
18766
+ */
18767
+ declare type WindowInitializedEvent = InitializedEvent_2;
18768
+
18769
+ /**
18770
+ * Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
18771
+ */
18772
+ declare class _WindowModule extends Base {
18773
+ /**
18774
+ * Asynchronously returns a Window object that represents an existing window.
18775
+ *
18776
+ * @example
18777
+ * ```js
18778
+ * async function createWin() {
18779
+ * const app = await fin.Application.start({
18780
+ * name: 'myApp',
18781
+ * uuid: 'app-1',
18782
+ * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrap.html',
18783
+ * autoShow: true
18784
+ * });
18785
+ * return await app.getWindow();
18786
+ * }
18787
+ * createWin().then(() => fin.Window.wrap({ uuid: 'app-1', name: 'myApp' }))
18788
+ * .then(win => console.log('wrapped window'))
18789
+ * .catch(err => console.log(err));
18790
+ * ```
18791
+ */
18792
+ wrap(identity: OpenFin_2.Identity): Promise<OpenFin_2.Window>;
18793
+ /**
18794
+ * Synchronously returns a Window object that represents an existing window.
18795
+ *
18796
+ * @example
18797
+ * ```js
18798
+ * async function createWin() {
18799
+ * const app = await fin.Application.start({
18800
+ * name: 'myApp',
18801
+ * uuid: 'app-1',
18802
+ * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrapSync.html',
18803
+ * autoShow: true
18804
+ * });
18805
+ * return await app.getWindow();
18806
+ * }
18807
+ * await createWin();
18808
+ * let win = fin.Window.wrapSync({ uuid: 'app-1', name: 'myApp' });
18809
+ * ```
18810
+ */
18811
+ wrapSync(identity: OpenFin_2.Identity): OpenFin_2.Window;
18812
+ /**
18813
+ * Creates a new Window.
18814
+ * @param options - Window creation options
18815
+ *
18816
+ * @example
18817
+ * ```js
18818
+ * async function createWindow() {
18819
+ * const winOption = {
18820
+ * name:'child',
18821
+ * defaultWidth: 300,
18822
+ * defaultHeight: 300,
18823
+ * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.create.html',
18824
+ * frame: true,
18825
+ * autoShow: true
18826
+ * };
18827
+ * return await fin.Window.create(winOption);
18828
+ * }
18829
+ *
18830
+ * createWindow().then(() => console.log('Window is created')).catch(err => console.log(err));
18831
+ * ```
18832
+ */
18833
+ create(options: OpenFin_2.WindowCreationOptions): Promise<OpenFin_2.Window>;
18834
+ /**
18835
+ * Asynchronously returns a Window object that represents the current window
18836
+ *
18837
+ * @example
18838
+ * ```js
18839
+ * fin.Window.getCurrent()
18840
+ * .then(wnd => console.log('current window'))
18841
+ * .catch(err => console.log(err));
18842
+ *
18843
+ * ```
18844
+ */
18845
+ getCurrent(): Promise<OpenFin_2.Window>;
18846
+ /**
18847
+ * Synchronously returns a Window object that represents the current window
18848
+ *
18849
+ * @example
18850
+ * ```js
18851
+ * const wnd = fin.Window.getCurrentSync();
18852
+ * const info = await wnd.getInfo();
18853
+ * console.log(info);
18854
+ *
18855
+ * ```
18856
+ */
18857
+ getCurrentSync(): OpenFin_2.Window;
18858
+ }
18859
+
18860
+ /**
18861
+ * Generated when a child window is not responding.
18862
+ * @interface
18863
+ */
18864
+ declare type WindowNotRespondingEvent = BaseEvent_3 & {
18865
+ type: 'window-not-responding';
18866
+ };
18867
+
18868
+ /**
18869
+ * @interface
18870
+ */
18871
+ declare type WindowOptionDiff = {
18872
+ [key in keyof WindowOptions]: {
18873
+ oldVal: WindowOptions[key];
18874
+ newVal: WindowOptions[key];
18875
+ };
18876
+ };
18877
+
18878
+ /**
18879
+ * @interface
18880
+ */
18881
+ declare type WindowOptions = MutableWindowOptions & ConstWindowOptions;
18882
+
18883
+ declare type WindowOptionsChangedEvent = OpenFin_2.WindowEvents.WindowOptionsChangedEvent;
18884
+
18885
+ /**
18886
+ * @deprecated Renamed to {@link OptionsChangedEvent}.
18887
+ */
18888
+ declare type WindowOptionsChangedEvent_2 = OptionsChangedEvent;
18889
+
18890
+ declare type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
18891
+
18892
+ /**
18893
+ * Generated when a child window is responding.
18894
+ * @interface
18895
+ */
18896
+ declare type WindowRespondingEvent = BaseEvent_3 & {
18897
+ type: 'window-responding';
18898
+ };
18899
+
18900
+ /**
18901
+ * @deprecated Renamed to {@link RestoredEvent}.
18902
+ */
18903
+ declare type WindowRestoredEvent = RestoredEvent;
18904
+
18905
+ /**
18906
+ * @deprecated Renamed to {@link ShownEvent}.
18907
+ */
18908
+ declare type WindowShownEvent = ShownEvent_2;
18909
+
18910
+ /**
18911
+ * @deprecated Renamed to {@link ShowRequestedEvent}.
18912
+ */
18913
+ declare type WindowShowRequestedEvent = ShowRequestedEvent;
18914
+
18915
+ /**
18916
+ * A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
18917
+ * from {@link OpenFin.ViewEvents}.
18918
+ */
18919
+ 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;
18920
+
18921
+ /**
18922
+ * Generated when a child window starts loading.
18923
+ * @interface
18924
+ */
18925
+ declare type WindowStartLoadEvent = BaseEvent_3 & {
18926
+ type: 'window-start-load';
18927
+ };
18928
+
18929
+ /**
18930
+ * Visibility state of a window.
18931
+ */
18932
+ declare type WindowState = 'maximized' | 'minimized' | 'normal';
18933
+
18934
+ /**
18935
+ * A view-related event that fires natively on the `Window` topic. This means that these events *do* propagate
18936
+ * to the `Application` level, with the name pattern `window-view-eventname`.
18937
+ */
18938
+ declare type WindowViewEvent = {
18939
+ viewIdentity: OpenFin_2.Identity;
18940
+ } & (ViewAttachedEvent | ViewDetachedEvent);
18941
+
18942
+ /**
18943
+ * @interface
18944
+ */
18945
+ declare type WindowViewsPrintOptions = {
18946
+ content: 'views';
18947
+ includeSelf?: boolean;
18948
+ };
18949
+
18950
+ declare type Wire = EventEmitter & {
18951
+ connect(messageReciever: MessageReceiver): Promise<any>;
18952
+ connectSync(): any;
18953
+ send(data: any): Promise<any>;
18954
+ shutdown(): Promise<void>;
18955
+ getPort(): string;
18956
+ };
18957
+
18958
+ declare type WireConstructor = {
18959
+ new (onmessage: (data: any) => void): Wire;
18960
+ };
18961
+
18962
+ /**
18963
+ * @internal
18964
+ */
18965
+ declare type WithId<T extends AppVersionEventType> = `${T}.${string}`;
18966
+
18967
+ declare interface WithInterop {
18968
+ interop: InteropClient;
18969
+ }
18970
+
18971
+ /**
18972
+ * @internal
18973
+ */
18974
+ declare type WithoutId<T extends string> = T extends WithId<infer U> ? U : never;
18975
+
18976
+ declare type WithPositioningOptions<T extends {} = {}> = T & {
18977
+ positioningOptions?: OpenFin_2.PositioningOptions;
18978
+ };
18979
+
18980
+ /**
18981
+ * @internal
18982
+ * @interface
18983
+ */
18984
+ declare type WorkspacePlatformOptions = {
18985
+ /** Leaving this as any for now until we figure out what the shape should look like in Workspace */
18986
+ [key: string]: any;
18987
+ };
18988
+
18989
+ /**
18990
+ * A generic request to write any supported data to the clipboard.
18991
+ * @interface
18992
+ */
18993
+ declare type WriteAnyClipboardRequest = BaseClipboardRequest & {
18994
+ /**
18995
+ * Data to be written
18996
+ */
18997
+ data: {
18998
+ text?: string;
18999
+ html?: string;
19000
+ rtf?: string;
19001
+ } & Partial<Pick<WriteImageClipboardRequest, 'image'>>;
19002
+ };
19003
+
19004
+ /**
19005
+ * @deprecated - instead use WriteAnyClipboardRequest
19006
+ *
19007
+ * A generic request to write any supported data to the clipboard.
19008
+ *
19009
+ * @interface
19010
+ */
19011
+ declare type WriteAnyRequestType = WriteAnyClipboardRequest;
19012
+
19013
+ /**
19014
+ * A request to write data to the clipboard.
19015
+ * @interface
19016
+ */
19017
+ declare type WriteClipboardRequest = BaseClipboardRequest & {
19018
+ /**
19019
+ * Data to write to the clipboard.
19020
+ */
19021
+ data: string;
19022
+ };
19023
+
19024
+ /**
19025
+ * @interface
19026
+ */
19027
+ declare type WriteImageClipboardRequest = BaseClipboardRequest & {
19028
+ /**
19029
+ * Can be either a base64 string, or a DataURL string. If using DataURL, the
19030
+ * supported formats are `data:image/png[;base64],` and `data:image/jpeg[;base64],`.
19031
+ * Using other image/<format> DataURLs will throw an Error.
19032
+ */
19033
+ image: string;
19034
+ };
19035
+
19036
+ /**
19037
+ * @deprecated - instead use OpenFin.WriteClipboardRequest
19038
+ *
19039
+ * A request to write data to the clipboard.
19040
+ *
19041
+ * @interface
19042
+ */
19043
+ declare type WriteRequestType = WriteClipboardRequest;
19044
+
19045
+ export { }