@openfin/node-adapter 35.78.5 → 35.78.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -43,6 +43,8 @@ declare type Accelerator = {
43
43
  };
44
44
 
45
45
  /**
46
+ * Options to use when adding a view to a {@link TabStack}.
47
+ *
46
48
  * @interface
47
49
  */
48
50
  declare type AddViewOptions = CreateViewTarget & {
@@ -94,6 +96,10 @@ declare type Api = {
94
96
  sameOriginInjection?: boolean;
95
97
  enableDeprecatedSharedName?: boolean;
96
98
  };
99
+ /**
100
+ * Prevent fin API injection. If 'none', `fin` won't be available in this context.
101
+ */
102
+ fin?: InjectionType;
97
103
  };
98
104
 
99
105
  declare type ApiCall<Request, Response> = {
@@ -187,100 +193,6 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
187
193
  private window;
188
194
  /* Excluded from this release type: __constructor */
189
195
  private windowListFromIdentityList;
190
- /**
191
- * Adds a listener to the end of the listeners array for the specified event.
192
- * @param eventType - The type of the event.
193
- * @param listener - Called whenever an event of the specified type occurs.
194
- * @param options - Option to support event timestamps.
195
- *
196
- * @function addListener
197
- * @memberof Application
198
- * @instance
199
- * @tutorial Application.EventEmitter
200
- */
201
- /**
202
- * Adds a listener to the end of the listeners array for the specified event.
203
- * @param eventType - The type of the event.
204
- * @param listener - Called whenever an event of the specified type occurs.
205
- * @param options - Option to support event timestamps.
206
- *
207
- * @function on
208
- * @memberof Application
209
- * @instance
210
- * @tutorial Application.EventEmitter
211
- */
212
- /**
213
- * 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.
214
- * @param eventType - The type of the event.
215
- * @param listener - The callback function.
216
- * @param options - Option to support event timestamps.
217
- *
218
- * @function once
219
- * @memberof Application
220
- * @instance
221
- * @tutorial Application.EventEmitter
222
- */
223
- /**
224
- * Adds a listener to the beginning of the listeners array for the specified event.
225
- * @param eventType - The type of the event.
226
- * @param listener - The callback function.
227
- * @param options - Option to support event timestamps.
228
- *
229
- * @function prependListener
230
- * @memberof Application
231
- * @instance
232
- * @tutorial Application.EventEmitter
233
- */
234
- /**
235
- * 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.
236
- * The listener is added to the beginning of the listeners array.
237
- * @param eventType - The type of the event.
238
- * @param listener - The callback function.
239
- * @param options - Option to support event timestamps.
240
- *
241
- * @function prependOnceListener
242
- * @memberof Application
243
- * @instance
244
- * @tutorial Application.EventEmitter
245
- */
246
- /**
247
- * Remove a listener from the listener array for the specified event.
248
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
249
- * @param eventType - The type of the event.
250
- * @param listener - The callback function.
251
- * @param options - Option to support event timestamps.
252
- *
253
- * @function removeListener
254
- * @memberof Application
255
- * @instance
256
- * @tutorial Application.EventEmitter
257
- */
258
- /**
259
- * Removes all listeners, or those of the specified event.
260
- * @param eventType - The type of the event.
261
- *
262
- * @function removeAllListeners
263
- * @memberof Application
264
- * @instance
265
- * @tutorial Application.EventEmitter
266
- */
267
- /**
268
- * JumpListCategory interface
269
- * @typedef { object } JumpListCategory@typedef { object } JumpListCategory
270
- * @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.
271
- * @property { JumpListItem[] } items Array of JumpListItem objects
272
- */
273
- /**
274
- * @PORTED
275
- * JumpListItem interface
276
- * @typedef { object } JumpListItem@typedef { object } JumpListItem
277
- * @property { string } type One of the following: "task" or "separator". Defaults to task.
278
- * @property { string } title The text to be displayed for the JumpList Item. Should only be set if type is "task".
279
- * @property { string } description Description of the task (displayed in a tooltip). Should only be set if type is "task".
280
- * @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.
281
- * @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).
282
- * @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.
283
- */
284
196
  /**
285
197
  * Determines if the application is currently running.
286
198
  *
@@ -927,6 +839,7 @@ declare namespace ApplicationEvents {
927
839
  RespondingEvent,
928
840
  StartedEvent,
929
841
  ApplicationSourcedEvent,
842
+ ApplicationSourcedEventType,
930
843
  Event_3 as Event,
931
844
  ApplicationEvent,
932
845
  EventType_3 as EventType,
@@ -1299,6 +1212,11 @@ declare type ApplicationPermissions = {
1299
1212
  */
1300
1213
  declare type ApplicationSourcedEvent = ClosedEvent | ConnectedEvent_2 | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent_2 | StartedEvent | TrayIconClickedEvent | FileDownloadLocationChangedEvent;
1301
1214
 
1215
+ /**
1216
+ * Union of possible type values for an {@link ApplicationSourcedEvent}.
1217
+ */
1218
+ declare type ApplicationSourcedEventType = ApplicationSourcedEvent['type'];
1219
+
1302
1220
  declare type ApplicationState = OpenFin.ApplicationState;
1303
1221
 
1304
1222
  /**
@@ -3102,20 +3020,6 @@ declare type ClientInfo = Omit<ClientIdentity, 'isLocalEndpointId'> & {
3102
3020
  connectionUrl: string;
3103
3021
  };
3104
3022
 
3105
- /**
3106
- * @PORTED
3107
- * WriteRequestType interface
3108
- * @typedef { object } WriteRequestType@typedef { object } WriteRequestType
3109
- * @property { string } data Data to be written
3110
- * @property { string } [type] Clipboard Type
3111
- */
3112
- /**
3113
- * @PORTED
3114
- * OpenFin.WriteAnyClipboardRequest interface
3115
- * @typedef { object } OpenFin.WriteAnyClipboardRequest@typedef { object } OpenFin.WriteAnyClipboardRequest
3116
- * @property { string } data Data to be written
3117
- * @property { OpenFin.ClipboardSelectionType } [type] Clipboard Type defaults to 'clipboard', use 'selection' for linux
3118
- */
3119
3023
  /**
3120
3024
  * The Clipboard API allows reading and writing to the clipboard in multiple formats.
3121
3025
  *
@@ -3492,6 +3396,10 @@ declare type ConstructorOverride<T> = (Base: Constructor<T>) => Constructor<T>;
3492
3396
  * @interface
3493
3397
  */
3494
3398
  declare type ConstViewOptions = {
3399
+ /**
3400
+ * Configurations for API injection.
3401
+ */
3402
+ api: Api;
3495
3403
  /**
3496
3404
  * The name of the view.
3497
3405
  */
@@ -3640,7 +3548,7 @@ declare type ConstWindowOptions = {
3640
3548
  /**
3641
3549
  * @defaultValue true
3642
3550
  *
3643
- * Toggling off would keep the Window alive even if all its Views were closed.
3551
+ * Setting this to false would keep the Window alive even if all its Views were closed.
3644
3552
  * This is meant for advanced users and should be used with caution.
3645
3553
  * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
3646
3554
  * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
@@ -3650,7 +3558,8 @@ declare type ConstWindowOptions = {
3650
3558
  /**
3651
3559
  * @defaultValue 'all'
3652
3560
  *
3653
- * 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'.
3561
+ * When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
3562
+ + * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3654
3563
  * **NOTE:** - This option is ignored in non-Platforms apps.
3655
3564
  */
3656
3565
  viewsPreventingClose: 'all' | 'layout';
@@ -4457,7 +4366,7 @@ declare type CreateViewPayload = {
4457
4366
  /**
4458
4367
  * @interface
4459
4368
  */
4460
- declare type CreateViewTarget = LayoutIdentity & {
4369
+ declare type CreateViewTarget = (Identity_5 | LayoutIdentity) & {
4461
4370
  /**
4462
4371
  * If specified, view creation will not attach to a window and caller must
4463
4372
  * insert the view into the layout explicitly
@@ -4597,6 +4506,14 @@ declare type DestroyedEvent = BaseEvent_4 & {
4597
4506
  type: 'destroyed';
4598
4507
  };
4599
4508
 
4509
+ /**
4510
+ * @interface
4511
+ */
4512
+ declare type DeviceInfo = {
4513
+ vendorId: string | number;
4514
+ productId: string | number;
4515
+ };
4516
+
4600
4517
  /**
4601
4518
  * Generated when a page's theme color changes. This is usually due to encountering a meta tag.
4602
4519
  * @interface
@@ -4838,7 +4755,7 @@ declare type DownloadShelfOptions = {
4838
4755
  */
4839
4756
  size?: number;
4840
4757
  /**
4841
- * Color of the border, either a string name or a hex code. Defaults to chromium theme
4758
+ * Color of the border. Must be a 6-character hex code prefixed by #. Defaults to chromium theme
4842
4759
  * if absent.
4843
4760
  */
4844
4761
  color?: string;
@@ -5057,9 +4974,10 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
5057
4974
  } : never;
5058
4975
 
5059
4976
  declare interface Environment {
5060
- initLayout(fin: OpenFin.Fin<OpenFin.EntityType>, wire: Transport, options: OpenFin.InitLayoutOptions): Promise<OpenFin.LayoutManager<OpenFin.LayoutSnapshot>>;
4977
+ initLayoutManager(fin: OpenFin.Fin<OpenFin.EntityType>, wire: Transport, options: OpenFin.InitLayoutOptions): Promise<OpenFin.LayoutManager<OpenFin.LayoutSnapshot>>;
5061
4978
  createLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.CreateLayoutOptions): Promise<void>;
5062
4979
  destroyLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<void>;
4980
+ resolveLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<any>;
5063
4981
  initPlatform(fin: OpenFin.Fin<OpenFin.EntityType>, ...args: Parameters<OpenFin.Fin['Platform']['init']>): ReturnType<OpenFin.Fin['Platform']['init']>;
5064
4982
  observeBounds(element: Element, onChange: (bounds: DOMRect) => Promise<void> | void): () => void;
5065
4983
  writeToken(path: string, token: string): Promise<string>;
@@ -5281,7 +5199,7 @@ declare type EventType_7 = Event_10['type'];
5281
5199
  /**
5282
5200
  * Union of possible `type` values for a {@link SystemEvent}.
5283
5201
  */
5284
- declare type EventType_8 = SystemEvent['type'];
5202
+ declare type EventType_8 = Event_11['type'];
5285
5203
 
5286
5204
  /* Excluded from this release type: EventWithId */
5287
5205
 
@@ -5313,83 +5231,6 @@ declare type ExitCode = {
5313
5231
  declare class ExternalApplication extends EmitterBase<OpenFin.ExternalApplicationEvent> {
5314
5232
  identity: OpenFin.ApplicationIdentity;
5315
5233
  /* Excluded from this release type: __constructor */
5316
- /**
5317
- * Adds a listener to the end of the listeners array for the specified event.
5318
- * @param eventType - The type of the event.
5319
- * @param listener - Called whenever an event of the specified type occurs.
5320
- * @param options - Option to support event timestamps.
5321
- *
5322
- * @function addListener
5323
- * @memberof ExternalApplication
5324
- * @instance
5325
- * @tutorial ExternalApplication.EventEmitter
5326
- */
5327
- /**
5328
- * Adds a listener to the end of the listeners array for the specified event.
5329
- * @param eventType - The type of the event.
5330
- * @param listener - Called whenever an event of the specified type occurs.
5331
- * @param options - Option to support event timestamps.
5332
- *
5333
- * @function on
5334
- * @memberof ExternalApplication
5335
- * @instance
5336
- * @tutorial ExternalApplication.EventEmitter
5337
- */
5338
- /**
5339
- * 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.
5340
- * @param eventType - The type of the event.
5341
- * @param listener - The callback function.
5342
- * @param options - Option to support event timestamps.
5343
- *
5344
- * @function once
5345
- * @memberof ExternalApplication
5346
- * @instance
5347
- * @tutorial ExternalApplication.EventEmitter
5348
- */
5349
- /**
5350
- * Adds a listener to the beginning of the listeners array for the specified event.
5351
- * @param eventType - The type of the event.
5352
- * @param listener - The callback function.
5353
- * @param options - Option to support event timestamps.
5354
- *
5355
- * @function prependListener
5356
- * @memberof ExternalApplication
5357
- * @instance
5358
- * @tutorial ExternalApplication.EventEmitter
5359
- */
5360
- /**
5361
- * 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.
5362
- * The listener is added to the beginning of the listeners array.
5363
- * @param eventType - The type of the event.
5364
- * @param listener - The callback function.
5365
- * @param options - Option to support event timestamps.
5366
- *
5367
- * @function prependOnceListener
5368
- * @memberof ExternalApplication
5369
- * @instance
5370
- * @tutorial ExternalApplication.EventEmitter
5371
- */
5372
- /**
5373
- * Remove a listener from the listener array for the specified event.
5374
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
5375
- * @param eventType - The type of the event.
5376
- * @param listener - The callback function.
5377
- * @param options - Option to support event timestamps.
5378
- *
5379
- * @function removeListener
5380
- * @memberof ExternalApplication
5381
- * @instance
5382
- * @tutorial ExternalApplication.EventEmitter
5383
- */
5384
- /**
5385
- * Removes all listeners, or those of the specified event.
5386
- * @param eventType - The type of the event.
5387
- *
5388
- * @function removeAllListeners
5389
- * @memberof ExternalApplication
5390
- * @instance
5391
- * @tutorial ExternalApplication.EventEmitter
5392
- */
5393
5234
  /**
5394
5235
  * Retrieves information about the external application.
5395
5236
  *
@@ -5809,83 +5650,6 @@ declare type FoundInPageEvent = NamedEvent & {
5809
5650
  declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
5810
5651
  identity: OpenFin.Identity;
5811
5652
  /* Excluded from this release type: __constructor */
5812
- /**
5813
- * Adds the listener function to the end of the listeners array for the specified event type.
5814
- * @param eventType - The type of the event.
5815
- * @param listener - Called whenever an event of the specified type occurs.
5816
- * @param options - Option to support event timestamps.
5817
- *
5818
- * @function addListener
5819
- * @memberof Frame
5820
- * @instance
5821
- * @tutorial Frame.EventEmitter
5822
- */
5823
- /**
5824
- * Adds a listener to the end of the listeners array for the specified event.
5825
- * @param eventType - The type of the event.
5826
- * @param listener - Called whenever an event of the specified type occurs.
5827
- * @param options - Option to support event timestamps.
5828
- *
5829
- * @function on
5830
- * @memberof Frame
5831
- * @instance
5832
- * @tutorial Frame.EventEmitter
5833
- */
5834
- /**
5835
- * 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.
5836
- * @param eventType - The type of the event.
5837
- * @param listener - The callback function.
5838
- * @param options - Option to support event timestamps.
5839
- *
5840
- * @function once
5841
- * @memberof Frame
5842
- * @instance
5843
- * @tutorial Frame.EventEmitter
5844
- */
5845
- /**
5846
- * Adds a listener to the beginning of the listeners array for the specified event.
5847
- * @param eventType - The type of the event.
5848
- * @param listener - The callback function.
5849
- * @param options - Option to support event timestamps.
5850
- *
5851
- * @function prependListener
5852
- * @memberof Frame
5853
- * @instance
5854
- * @tutorial Frame.EventEmitter
5855
- */
5856
- /**
5857
- * 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.
5858
- * The listener is added to the beginning of the listeners array.
5859
- * @param eventType - The type of the event.
5860
- * @param listener - The callback function.
5861
- * @param options - Option to support event timestamps.
5862
- *
5863
- * @function prependOnceListener
5864
- * @memberof Frame
5865
- * @instance
5866
- * @tutorial Frame.EventEmitter
5867
- */
5868
- /**
5869
- * Remove a listener from the listener array for the specified event.
5870
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
5871
- * @param eventType - The type of the event.
5872
- * @param listener - The callback function.
5873
- * @param options - Option to support event timestamps.
5874
- *
5875
- * @function removeListener
5876
- * @memberof Frame
5877
- * @instance
5878
- * @tutorial Frame.EventEmitter
5879
- */
5880
- /**
5881
- * Removes all listeners, or those of the specified event.
5882
- * @param eventType - The type of the event.
5883
- *
5884
- * @function removeAllListeners
5885
- * @memberof Frame
5886
- * @instance
5887
- * @tutorial Frame.EventEmitter
5888
- */
5889
5653
  /**
5890
5654
  * Returns a frame info object for the represented frame.
5891
5655
  *
@@ -6804,6 +6568,8 @@ declare type InitPlatformOptions = {
6804
6568
  interopOverride?: OverrideCallback<InteropBroker> | ConstructorOverride<InteropBroker>[];
6805
6569
  };
6806
6570
 
6571
+ declare type InjectionType = 'none' | 'global';
6572
+
6807
6573
  /**
6808
6574
  * Generated when the value of the element changes.
6809
6575
  * @interface
@@ -7148,56 +6914,6 @@ declare class InteropBroker extends Base {
7148
6914
  static createClosedConstructor(...args: ConstructorParameters<typeof InteropBroker>): {
7149
6915
  new (): InteropBroker;
7150
6916
  };
7151
- /**
7152
- * @REMOVED
7153
- * SetContextOptions interface
7154
- * @typedef { object } SetContextOptions@typedef { object } SetContextOptions
7155
- * @property { Context } {context} - New context to set.
7156
- */
7157
- /**
7158
- * @REMOVED
7159
- * GetContextOptions interface
7160
- * @typedef { object } GetContextOptions@typedef { object } GetContextOptions
7161
- * @property { string } [contextType] - Context Type
7162
- */
7163
- /**
7164
- * @REMOVED
7165
- * JoinContextGroupOptions interface
7166
- * @typedef { object } JoinContextGroupOptions@typedef { object } JoinContextGroupOptions
7167
- * @property { string } contextGroupId - Id of the context group.
7168
- * @property { Identity | ClientIdentity } [target] - Identity of the entity you wish to join to a context group.
7169
- */
7170
- /**
7171
- * @REMOVED
7172
- * AddClientToContextGroupOptions interface
7173
- * @typedef { object } AddClientToContextGroupOptions@typedef { object } AddClientToContextGroupOptions
7174
- * @property { string } contextGroupId - Name of the context group.
7175
- */
7176
- /**
7177
- * @REMOVED
7178
- * RemoveFromContextGroupOptions interface
7179
- * @typedef { object } RemoveFromContextGroupOptions@typedef { object } RemoveFromContextGroupOptions
7180
- * @property { Identity | ClientIdentity } target - Identity of the entity you wish to join to a context group.
7181
- */
7182
- /**
7183
- * @REMOVED
7184
- * GetInfoForContextGroupOptions interface
7185
- * @typedef { object } GetInfoForContextGroupOptions@typedef { object } GetInfoForContextGroupOptions
7186
- * @property { string } contextGroupId - Name of the context group to get info for.
7187
- */
7188
- /**
7189
- * @REMOVED
7190
- * GetAllClientsInContextGroupOptions interface
7191
- * @typedef { object } GetAllClientsInContextGroupOptions@typedef { object } GetAllClientsInContextGroupOptions
7192
- * @property { string } contextGroupId - Name of the context group to get info for.
7193
- */
7194
- /**
7195
- * @PORTED
7196
- * InfoForIntentOptions interface
7197
- * @typedef { object } InfoForIntentOptions@typedef { object } InfoForIntentOptions
7198
- * @property { string } name Name of the intent to get info for.
7199
- * @property { Context } [context] Optional context.
7200
- */
7201
6917
  /**
7202
6918
  * Sets a context for the context group of the incoming current entity.
7203
6919
  * @param setContextOptions - New context to set.
@@ -7441,7 +7157,7 @@ declare class InteropBroker extends Base {
7441
7157
  * // }
7442
7158
  * ```
7443
7159
  *
7444
- * More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/IntentResolution).
7160
+ * More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/Metadata#intentresolution).
7445
7161
  *
7446
7162
  * @param contextForIntent Data passed between entities and applications.
7447
7163
  * @param clientIdentity Identity of the Client making the request.
@@ -7697,95 +7413,6 @@ declare type InteropBrokerOptions = {
7697
7413
  logging?: InteropLoggingOptions;
7698
7414
  };
7699
7415
 
7700
- /**
7701
- * @PORTED
7702
- * @typedef { object } Intent
7703
- * @summary The combination of an action and a context that is passed to an application for resolution.
7704
- * @property { string } name Name of the intent.
7705
- * @property { Context } context Data associated with the intent
7706
- */
7707
- /**
7708
- * @REMOVED
7709
- * @typedef { object } Subscription
7710
- * @summary Object returned when subscribing a handler.
7711
- * @property { function } unsubscribe Function to unsubscribe the handler.
7712
- */
7713
- /**
7714
- * @typedef { function } ContextHandler
7715
- * @summary Subscription function for addContextHandler.
7716
- */
7717
- /**
7718
- * @typedef { function } IntentHandler
7719
- * @summary Subscription function for registerIntentHandler
7720
- */
7721
- /**
7722
- * @PORTED
7723
- * @typedef { object } ClientIdentity
7724
- * @summary The Identity for a Channel Client. Includes endpointId to differentiate between different connections for an entity.
7725
- * @property {string} uuid GUID of an application.
7726
- * @property {string} name Name of an entity in an application.
7727
- * @property {string} endpointId Unique differentiator for different Channel connections for an entity.
7728
- */
7729
- /**
7730
- * @PORTED
7731
- * @typedef { object } ContextGroupInfo
7732
- * @summary Information for a Context Group. Contains metadata for displaying the group properly.
7733
- * @property {string} id Name of the context group
7734
- * @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.
7735
- */
7736
- /**
7737
- * @PORTED
7738
- * @typedef { object } DisplayMetadata
7739
- * @summary The display data for a Context Group.
7740
- * @property {string} name A user-readable name for this context group, e.g: `"Red"`
7741
- * @property {string} [color] The color that should be associated within this context group when displaying this context group in a UI, e.g: `0xFF0000`.
7742
- * @property {string} [glyph] A URL of an image that can be used to display this context group
7743
- */
7744
- /**
7745
- * @PORTED
7746
- * @typedef { object } Context
7747
- * @summary Data passed between entities and applications.
7748
- * @property {object} [id] An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
7749
- * @property {string} [name] User-readable name for the incoming context.
7750
- * @property {string} type Conserved type for the context (e.g. `instrument` or `country`)
7751
- */
7752
- /**
7753
- * @REMOVED
7754
- * @typedef { object } ContextForIntent
7755
- * @summary Data passed between entities and applications, including an optional metadata.
7756
- * @property {object} [id] An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
7757
- * @property {string} [name] User-readable name for the incoming context.
7758
- * @property {string} type Conserved type for the context (e.g. `instrument` or `country`)
7759
- * @property {any} [metadata]
7760
- */
7761
- /**
7762
- * @REMOVED
7763
- * @typedef { object } SessionContextGroup
7764
- * @summary An instance of a SessionContextGroup
7765
- * @property {string} id The SessionContextGroup's id.
7766
- * @property {setContext} setContext Sets a context of a certain type
7767
- * @property {getCurrentContext} getCurrentContext Gets the currently set context of a certain type
7768
- * @property {addContextHandler} addContextHandler Adds a handler for context change.
7769
- */
7770
- /**
7771
- * @typedef {function} setContext
7772
- * @summary A SessionContextGroup instance method for setting a context in the SessionContextGroup.
7773
- * @param context The Context to be set.
7774
- *
7775
- */
7776
- /**
7777
- * @typedef {function} getCurrentContext
7778
- * @summary A SessionContextGroup instance method for getting the current context of a certain type.
7779
- * @param contextType The Context Type to get. If not specified the last contextType set would get used.
7780
- *
7781
- */
7782
- /**
7783
- * @typedef {function} addContextHandler
7784
- * @summary A SessionContextGroup instance method for adding a handler for context change.
7785
- * @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.
7786
- * @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.
7787
- *
7788
- */
7789
7416
  /**
7790
7417
  * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}
7791
7418
  *
@@ -8221,13 +7848,6 @@ declare type InteropLoggingActions = 'beforeAction' | 'afterAction';
8221
7848
  */
8222
7849
  declare type InteropLoggingOptions = Record<InteropLoggingActions, InteropActionLoggingOption>;
8223
7850
 
8224
- /**
8225
- * @PORTED
8226
- * @typedef { object } InteropConfig
8227
- * @summary Information relevant to the Interop Broker.
8228
- * @property {string} [currentContextGroup] Context Group for the client. (green, yellow, red, etc.)
8229
- * @property {string} [providerId] When provided, automatically connects the client to the specified provider uuid
8230
- */
8231
7851
  /**
8232
7852
  * Manages creation of Interop Brokers and Interop Clients. These APIs are called under-the-hood in Platforms.
8233
7853
  *
@@ -8617,7 +8237,7 @@ declare type LaunchIntoPlatformPayload = {
8617
8237
  declare class Layout extends Base {
8618
8238
  #private;
8619
8239
  /* Excluded from this release type: init */
8620
- identity: OpenFin.LayoutIdentity;
8240
+ identity: OpenFin.Identity | OpenFin.LayoutIdentity;
8621
8241
  private platform;
8622
8242
  wire: Transport;
8623
8243
  /* Excluded from this release type: __constructor */
@@ -8833,25 +8453,24 @@ declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'r
8833
8453
  */
8834
8454
  declare type LayoutIdentity = Identity_5 & {
8835
8455
  /**
8836
- * The name of the layout an action should be targeted to. When not provided,
8837
- * OpenFin attempts to resolve the instance via visibility checks.
8456
+ * The name of the layout in a given window.
8838
8457
  */
8839
- layoutName?: string;
8458
+ layoutName: string;
8840
8459
  };
8841
8460
 
8842
8461
  /**
8843
- * Generated when a window and all of its layout's views have either finished or failed navigation.
8462
+ * Generated when the window is created, and all of its layout's views have either finished or failed
8463
+ * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
8844
8464
  * @interface
8845
8465
  */
8846
8466
  declare type LayoutInitializedEvent = BaseEvent_5 & {
8847
8467
  type: 'layout-initialized';
8468
+ layoutIdentity: OpenFin.LayoutIdentity;
8848
8469
  ofViews: (OpenFin.Identity & {
8849
8470
  entityType: 'view';
8850
8471
  })[];
8851
8472
  };
8852
8473
 
8853
- /* Excluded from this release type: LayoutInstance */
8854
-
8855
8474
  /**
8856
8475
  * Represents the arrangement of Views within a Platform window's Layout. We do not recommend trying
8857
8476
  * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot}.
@@ -8879,7 +8498,7 @@ declare type LayoutItemConfig = {
8879
8498
  *
8880
8499
  * **NOTE**: Internal use only. This type is reserved for Workspace Browser implementation.
8881
8500
  *
8882
- * Responsible for aggergating all layout snapshots and storing LayoutInstances
8501
+ * Responsible for aggregating all layout snapshots and storing layout instances
8883
8502
  */
8884
8503
  declare interface LayoutManager<T extends LayoutSnapshot> {
8885
8504
  /**
@@ -8903,16 +8522,6 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
8903
8522
  * @throws if Object.keys(snapshot).length > 1
8904
8523
  */
8905
8524
  applyLayoutSnapshot(snapshot: T): Promise<void>;
8906
- /**
8907
- * Called at the start of layout initialization. Adds a new LayoutInstance if the snapshot
8908
- * contains a single layout.
8909
- *
8910
- * Throws if the snapshot contains more than 1 layout, it is expected that the user handles calling
8911
- * fin.Platform.Layout.create() once for each layout to properly connect it to their UI state.
8912
- *
8913
- * @param snapshot
8914
- * @throws if Object.keys(snapshot).length > 1
8915
- */
8916
8525
  /**
8917
8526
  * @experimental
8918
8527
  *
@@ -8933,31 +8542,49 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
8933
8542
  /**
8934
8543
  * @experimental
8935
8544
  *
8936
- * @param layoutIdentity
8937
- * @returns
8545
+ * A hook provided to the consumer for controlling how OpenFin routes Layout API calls. Override
8546
+ * this method to control the target layout for Layout API calls.
8547
+ *
8548
+ * Example use case: You have hidden all the layouts and are showing a dialog that will
8549
+ * execute an API call (ex: Layout.replace()) - override this method and save the
8550
+ * "last visible" layout identity and return it.
8551
+ *
8552
+ * By default, OpenFin will use a series of checks to determine which Layout the API
8553
+ * call must route to in this order of precedence:
8554
+ * - try to resolve the layout from the layoutIdentity, throws if missing
8555
+ * - if there is only 1 layout, resolves that one
8556
+ * - enumerates all layouts checks visibility via element offsetTop/Left + window.innerHeight/Width
8557
+ * - returns undefined
8558
+ *
8559
+ * @param identity
8560
+ * @returns LayoutIdentity | undefined
8938
8561
  */
8939
- resolveLayout(layoutIdentity?: LayoutIdentity): Promise<LayoutInstance>;
8562
+ resolveLayoutIdentity(identity?: Identity_5 | LayoutIdentity): LayoutIdentity | undefined;
8940
8563
  /**
8941
8564
  * @experimental
8942
8565
  *
8943
- * Returns a LayoutInstance if one exists with the name layoutIdentity.layoutName.
8944
- * Throws if it does not exist.
8945
- * @param layoutName
8946
- * @returns
8566
+ * A hook provided to the consumer when it's time to remove a layout. Use this hook to
8567
+ * update your local state and remove the layout for the given LayoutIdentity. Note that
8568
+ * this hook does not call `fin.Platform.Layout.destroy()` for you, instead it is to
8569
+ * signify to your application it's time to destroy this layout.
8570
+ *
8571
+ * 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.
8572
+ *
8573
+ * @param LayoutIdentity
8947
8574
  */
8948
- getLayoutByName(layoutName: string): LayoutInstance;
8575
+ removeLayout({ layoutName }: LayoutIdentity): Promise<void>;
8949
8576
  /**
8950
8577
  * @experimental
8951
8578
  */
8952
- getLayouts(): Record<string, LayoutInstance>;
8579
+ getLayoutIdentityForView(viewIdentity: Identity_5): LayoutIdentity;
8953
8580
  /**
8954
8581
  * @experimental
8955
8582
  */
8956
- getLayoutIdentityForView(viewIdentity: Identity_5): LayoutIdentity;
8583
+ isLayoutVisible({ layoutName }: LayoutIdentity): boolean;
8957
8584
  /**
8958
8585
  * @experimental
8959
8586
  */
8960
- isLayoutVisible({ layoutName }: LayoutIdentity): boolean;
8587
+ size(): number;
8961
8588
  }
8962
8589
 
8963
8590
  /**
@@ -9004,7 +8631,7 @@ declare class LayoutModule extends Base {
9004
8631
  * const layoutConfig = await layout.getConfig();
9005
8632
  * ```
9006
8633
  */
9007
- wrap(identity: OpenFin.LayoutIdentity): Promise<OpenFin.Layout>;
8634
+ wrap(identity: OpenFin.Identity | OpenFin.LayoutIdentity): Promise<OpenFin.Layout>;
9008
8635
  /**
9009
8636
  * Synchronously returns a Layout object that represents a Window's layout.
9010
8637
  *
@@ -9024,7 +8651,7 @@ declare class LayoutModule extends Base {
9024
8651
  * const layoutConfig = await layout.getConfig();
9025
8652
  * ```
9026
8653
  */
9027
- wrapSync(identity: OpenFin.LayoutIdentity): OpenFin.Layout;
8654
+ wrapSync(identity: OpenFin.Identity | OpenFin.LayoutIdentity): OpenFin.Layout;
9028
8655
  /**
9029
8656
  * Asynchronously returns a Layout object that represents a Window's layout.
9030
8657
  *
@@ -9121,7 +8748,7 @@ declare type LayoutOptions = {
9121
8748
  * @defaultValue false
9122
8749
  *
9123
8750
  * Limits the area to which tabs can be dragged.
9124
- * If true, stack headers are the only areas where tabs can be dropped.
8751
+ * If true, the layout container is the only area where tabs can be dropped.
9125
8752
  */
9126
8753
  constrainDragToContainer?: boolean;
9127
8754
  /**
@@ -9192,6 +8819,9 @@ declare type LayoutOptions = {
9192
8819
  };
9193
8820
  };
9194
8821
 
8822
+ /**
8823
+ * Represents the position of an item in a layout relative to another.
8824
+ */
9195
8825
  declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
9196
8826
 
9197
8827
  /**
@@ -9200,11 +8830,12 @@ declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
9200
8830
  declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
9201
8831
 
9202
8832
  /**
9203
- * Generated when a window and all of its layout's views have been created and can receive API calls.
8833
+ * Generated when the layout and all of the its views have been created and can receive API calls.
9204
8834
  * @interface
9205
8835
  */
9206
8836
  declare type LayoutReadyEvent = BaseEvent_5 & {
9207
8837
  type: 'layout-ready';
8838
+ layoutIdentity: OpenFin.LayoutIdentity;
9208
8839
  views: (OpenFin.Identity & {
9209
8840
  success: boolean;
9210
8841
  })[];
@@ -9909,7 +9540,7 @@ declare type MutableWindowOptions = {
9909
9540
  showTaskbarIcon: boolean;
9910
9541
  interop: InteropConfig;
9911
9542
  /* Excluded from this release type: _internalWorkspaceData */
9912
- workspacePlatform: WorkspacePlatformOptions;
9543
+ workspacePlatform: unknown;
9913
9544
  };
9914
9545
 
9915
9546
  declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;
@@ -10097,6 +9728,7 @@ declare namespace OpenFin {
10097
9728
  ResizeRegion,
10098
9729
  Accelerator,
10099
9730
  Api,
9731
+ InjectionType,
10100
9732
  NavigationRules,
10101
9733
  ContentNavigation,
10102
9734
  ContentRedirect,
@@ -10142,6 +9774,7 @@ declare namespace OpenFin {
10142
9774
  WebPermission,
10143
9775
  VerboseWebPermission,
10144
9776
  OpenExternalPermission,
9777
+ DeviceInfo,
10145
9778
  Permissions_2 as Permissions,
10146
9779
  PlatformWindowCreationOptions,
10147
9780
  PlatformWindowOptions,
@@ -10299,7 +9932,6 @@ declare namespace OpenFin {
10299
9932
  InitLayoutOptions,
10300
9933
  LayoutManagerConstructor,
10301
9934
  LayoutManagerOverride,
10302
- LayoutInstance,
10303
9935
  LayoutManager,
10304
9936
  CreateLayoutOptions,
10305
9937
  PresetLayoutOptions_2 as PresetLayoutOptions,
@@ -10491,6 +10123,7 @@ declare type Permissions_2 = {
10491
10123
  Application?: Partial<ApplicationPermissions>;
10492
10124
  System?: Partial<SystemPermissions>;
10493
10125
  webAPIs?: WebPermission[];
10126
+ devices?: DeviceInfo[];
10494
10127
  };
10495
10128
 
10496
10129
  declare type PermissionState_2 = 'granted' | 'denied' | 'unavailable';
@@ -11403,7 +11036,17 @@ declare interface PlatformProvider {
11403
11036
  */
11404
11037
  getSnapshot(payload: undefined, identity: OpenFin.Identity): Promise<OpenFin.Snapshot>;
11405
11038
  /* Excluded from this release type: getInitialLayoutSnapshot */
11406
- /* Excluded from this release type: createViewsForLayout */
11039
+ /**
11040
+ * @experimental
11041
+ *
11042
+ * This API is called during the {@link PlatformProvider.getSnapshot()} call.
11043
+ * Gets the current state of a particular window and its views and returns an object that
11044
+ * can be added to the {@link OpenFin.Snapshot.windows} property. Override this function if
11045
+ * you wish to mutate each window snapshot during the {@link PlatformProvider.getSnapshot()} call
11046
+ * @param identity
11047
+ * @param callerIdentity
11048
+ */
11049
+ getWindowSnapshot(identity: OpenFin.Identity, callerIdentity: OpenFin.Identity): Promise<OpenFin.WindowCreationOptions>;
11407
11050
  /* Excluded from this release type: getViewSnapshot */
11408
11051
  /**
11409
11052
  * Called when a snapshot is being applied and some windows in that snapshot would be fully or partially off-screen.
@@ -12831,7 +12474,7 @@ declare type ReplaceLayoutPayload = {
12831
12474
  /**
12832
12475
  * Identity of the window whose layout will be replaced.
12833
12476
  */
12834
- target: LayoutIdentity;
12477
+ target: Identity_5 | LayoutIdentity;
12835
12478
  };
12836
12479
 
12837
12480
  /**
@@ -13662,83 +13305,6 @@ declare type SubscriptionOptions = {
13662
13305
  declare class System extends EmitterBase<OpenFin.SystemEvent> {
13663
13306
  /* Excluded from this release type: __constructor */
13664
13307
  private sendExternalProcessRequest;
13665
- /**
13666
- * Adds a listener to the end of the listeners array for the specified event.
13667
- * @param eventType - The type of the event.
13668
- * @param listener - Called whenever an event of the specified type occurs.
13669
- * @param options - Option to support event timestamps.
13670
- *
13671
- * @function addListener
13672
- * @memberof System
13673
- * @instance
13674
- * @tutorial System.EventEmitter
13675
- */
13676
- /**
13677
- * Adds a listener to the end of the listeners array for the specified event.
13678
- * @param eventType - The type of the event.
13679
- * @param listener - Called whenever an event of the specified type occurs.
13680
- * @param options - Option to support event timestamps.
13681
- *
13682
- * @function on
13683
- * @memberof System
13684
- * @instance
13685
- * @tutorial System.EventEmitter
13686
- */
13687
- /**
13688
- * 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.
13689
- * @param eventType - The type of the event.
13690
- * @param listener - The callback function.
13691
- * @param options - Option to support event timestamps.
13692
- *
13693
- * @function once
13694
- * @memberof System
13695
- * @instance
13696
- * @tutorial System.EventEmitter
13697
- */
13698
- /**
13699
- * Adds a listener to the beginning of the listeners array for the specified event.
13700
- * @param eventType - The type of the event.
13701
- * @param listener - The callback function.
13702
- * @param options - Option to support event timestamps.
13703
- *
13704
- * @function prependListener
13705
- * @memberof System
13706
- * @instance
13707
- * @tutorial System.EventEmitter
13708
- */
13709
- /**
13710
- * 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.
13711
- * The listener is added to the beginning of the listeners array.
13712
- * @param eventType - The type of the event.
13713
- * @param listener - The callback function.
13714
- * @param options - Option to support event timestamps.
13715
- *
13716
- * @function prependOnceListener
13717
- * @memberof System
13718
- * @instance
13719
- * @tutorial System.EventEmitter
13720
- */
13721
- /**
13722
- * Remove a listener from the listener array for the specified event.
13723
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
13724
- * @param eventType - The type of the event.
13725
- * @param listener - The callback function.
13726
- * @param options - Option to support event timestamps.
13727
- *
13728
- * @function removeListener
13729
- * @memberof System
13730
- * @instance
13731
- * @tutorial System.EventEmitter
13732
- */
13733
- /**
13734
- * Removes all listeners, or those of the specified event.
13735
- * @param eventType - The type of the event.
13736
- *
13737
- * @function removeAllListeners
13738
- * @memberof System
13739
- * @instance
13740
- * @tutorial System.EventEmitter
13741
- */
13742
13308
  /**
13743
13309
  * Returns the version of the runtime. The version contains the major, minor,
13744
13310
  * build and revision numbers.
@@ -15322,20 +14888,6 @@ declare interface TabDragListener extends EventEmitter_2 {
15322
14888
  contentItem: ContentItem;
15323
14889
  }
15324
14890
 
15325
- /**
15326
- * @typedef {string} LayoutPosition
15327
- * @summary Represents the position of an item in a layout relative to another. Possible values are 'top', 'bottom', 'left' and 'right'.
15328
- */
15329
- /**
15330
- * @typedef {object} StackCreationOptions
15331
- * @summary Stack creation options.
15332
- * @property {LayoutPosition} [position] - The position to create the new {@link TabStack} in, relative to the given adjacent {@link TabStack}. Defaults to 'right'.
15333
- */
15334
- /**
15335
- * @typedef {object} TabStack~AddViewOptions
15336
- * @summary Options to use when adding a view to a {@link TabStack}
15337
- * @property {number} [index] - Insertion index when adding the view. Defaults to 0.
15338
- */
15339
14891
  /**
15340
14892
  * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
15341
14893
  */
@@ -15781,175 +15333,12 @@ declare type VerboseWebPermission = {
15781
15333
  declare type View = OpenFin.View;
15782
15334
 
15783
15335
  /**
15784
- * @PORTED
15785
- * @typedef {object} View~options
15786
- * @summary View creation options.
15787
- * @desc This is the options object required by {@link View.create View.create}.
15788
- *
15789
- * Note that `name` and `target` are the only required properties — albeit the `url` property is usually provided as well
15790
- * (defaults to `"about:blank"` when omitted).
15791
- *
15792
- * @property {object} [experimental]
15793
- * Configurations for API injection.
15794
- *
15795
- * @property {boolean} [experimental.childWindows] Configure if the runtime should enable child windows for views.
15796
- *
15797
- * @property {object} [accelerator]
15798
- * Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
15799
- *
15800
- * @property {boolean} [accelerator.devtools=false]
15801
- * If `true`, enables the devtools keyboard shortcut:<br>
15802
- * `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
15803
- *
15804
- * @property {boolean} [accelerator.reload=false]
15805
- * If `true`, enables the reload keyboard shortcuts:<br>
15806
- * `Ctrl` + `R` _(Windows)_<br>
15807
- * `F5` _(Windows)_<br>
15808
- * `Command` + `R` _(Mac)_
15809
- *
15810
- * @property {boolean} [accelerator.reloadIgnoringCache=false]
15811
- * If `true`, enables the reload-from-source keyboard shortcuts:<br>
15812
- * `Ctrl` + `Shift` + `R` _(Windows)_<br>
15813
- * `Shift` + `F5` _(Windows)_<br>
15814
- * `Command` + `Shift` + `R` _(Mac)_
15815
- *
15816
- * @property {boolean} [accelerator.zoom=false]
15817
- * If `true`, enables the zoom keyboard shortcuts:<br>
15818
- * `Ctrl` + `+` _(Zoom In)_<br>
15819
- * `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
15820
- * `Ctrl` + `NumPad+` _(Zoom In)_<br>
15821
- * `Ctrl` + `-` _(Zoom Out)_<br>
15822
- * `Ctrl` + `Shift` + `-` _(Zoom Out)_<br>
15823
- * `Ctrl` + `NumPad-` _(Zoom Out)_<br>
15824
- * `Ctrl` + `Scroll` _(Zoom In & Out)_<br>
15825
- * `Ctrl` + `0` _(Restore to 100%)_
15826
- *
15827
- * @property {object} [api]
15828
- * Configurations for API injection.
15829
- *
15830
- * @property {object} [api.iframe] Configure if the the API should be injected into iframes based on domain.
15831
- *
15832
- * @property {boolean} [api.iframe.crossOriginInjection=false] Controls if the `fin` API object is present for cross origin iframes.
15833
- * @property {boolean} [api.iframe.sameOriginInjection=true] Controls if the `fin` API object is present for same origin iframes.
15834
- *
15835
- * @property {string} [autoplayPolicy="no-user-gesture-required"]
15836
- * Autoplay policy to apply to content in the window, can be
15837
- * `no-user-gesture-required`, `user-gesture-required`,
15838
- * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
15839
- *
15840
- * @property {object} [autoResize] AutoResize options
15841
- *
15842
- * @property {object} [bounds] initial bounds given relative to the window.
15843
- *
15844
- * @property {string} [backgroundColor="#FFF"] - _Updatable._
15845
- * The view’s _backfill_ color as a hexadecimal value. Not to be confused with the content background color
15846
- * (`document.body.style.backgroundColor`),
15847
- * this color briefly fills a view’s (a) content area before its content is loaded as well as (b) newly exposed
15848
- * areas when growing a window. Setting
15849
- * this value to the anticipated content background color can help improve user experience.
15850
- * Default is white.
15851
- *
15852
- * @property {object} [contentNavigation]
15853
- * Restrict navigation to URLs that match an allowed pattern.
15854
- * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
15855
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
15856
- * @property {string[]} [contentNavigation.allowlist=[]] List of allowed URLs.
15857
- * @property {string[]} [contentNavigation.denylist=[]] List of denied URLs.
15858
- *
15859
- * @property {object} [contentRedirect]
15860
- * Restrict redirects to URLs that match an allowed pattern.
15861
- * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
15862
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
15863
- * @property {string[]} [contentRedirect.allowlist=[]] List of allowed URLs.
15864
- * @property {string[]} [contentRedirect.denylist=[]] List of denied URLs.
15865
- *
15866
- * @property {object} [contextMenuSettings] - _Updatable._
15867
- * Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
15868
- * Configure the context menu when right-clicking on a view.
15869
- * @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
15870
- * @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
15871
- * @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
15872
- *
15873
- * @property {object} [contextMenuOptions] - _Updatable._
15874
- * Configure the context menu when right-clicking on a view. Supported menu items:
15875
- * 'separator'
15876
- * 'cut'
15877
- * 'copy'
15878
- * 'copyImage',
15879
- * 'paste'
15880
- * 'spellCheck'
15881
- * 'inspect'
15882
- * 'reload'
15883
- * 'navigateForward'
15884
- * 'navigateBack'
15885
- * 'print'
15886
- * @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
15887
- * @property {string[]} [contextMenuOptions.template=[]] List of context menu items to display on right-click.
15888
- *
15889
- * @property {any} [customData=""] - _Updatable._
15890
- * A field that the user can attach serializable data to be ferried around with the view options.
15891
- * _When omitted, the default value of this property is the empty string (`""`)._
15336
+ * A View can be used to embed additional web content into a Window.
15337
+ * It is like a child window, except it is positioned relative to its owning window.
15338
+ * It has the ability to listen for {@link OpenFin.ViewEvents View-specific events}.
15892
15339
  *
15893
- * @property {any} [customContext=""] - _Updatable._
15894
- * A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
15895
- * is called.
15896
- * When omitted, the default value of this property is the empty string (`""`).
15897
- * As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
15898
- *
15899
- * @property {object[]} [hotkeys=[]] - _Updatable._
15900
- * Defines the list of hotkeys that will be emitted as a `hotkey` event on the view. For usage example see [example]{@tutorial hotkeys}.
15901
- * Within Platform, OpenFin also implements a set of pre-defined actions called
15902
- * [keyboard commands]{@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands}
15903
- * that can be assigned to a specific hotkey in the platform manifest.
15904
- * @property {string} hotkeys.keys The key combination of the hotkey, i.e. "Ctrl+T"
15905
- * @property {boolean} [hotkeys.preventDefault=false] preventDefault will prevent the page keydown/keyup events from being emitted.
15906
- *
15907
- * @property {boolean} [isClosable=true] **Platforms Only.** If false, the view will be persistent and can't be closed through
15908
- * either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
15909
- * if the view isn't part of the new layout when running `Layout.replace`.
15910
- *
15911
- * @property {string} name
15912
- * The name of the view.
15913
- *
15914
- * @property {boolean} [detachOnClose=false] - _Updatable._
15915
- * Platforms Only. If true, will hide and detach the View from the window for later use instead of closing,
15916
- * allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
15917
- *
15918
- * @property {string} [manifestUrl] **Platforms Only.** Url to a manifest that contains View Options. Properties other than manifestUrl can still be used
15919
- * but the properties in the manifest will take precedence if there is any collision.
15920
- *
15921
- * @property {preloadScript[]} [preloadScripts] - _Inheritable_
15922
- * A list of scripts that are eval'ed before other scripts in the page. When omitted, _inherits_
15923
- * from the parent application.
15924
- *
15925
- * @property {boolean} [preventDragOut=false] **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
15926
- *
15927
- * @property {string} [processAffinity=<application uuid>]
15928
- * A string to attempt to group renderers together. Will only be used if pages are on the same origin.
15929
- *
15930
- * @property {boolean} [spellCheck=false]
15931
- * Enable spell check in input text fields for the view.
15932
- *
15933
- * @property {Identity} [target]
15934
- * The identity of the window this view should be attached to.
15935
- *
15936
- * @property {string} [url="about:blank"]
15937
- * The URL of the view.
15938
- *
15939
- * @property {string} [uuid=<application uuid>]
15940
- * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
15941
- * If omitted, defaults to the `uuid` of the application spawning the view.
15942
- * If given, must match the `uuid` of the application spawning the view.
15943
- * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
15944
- * really no need to provide it.
15945
- */
15946
- /**
15947
- * A View can be used to embed additional web content into a Window.
15948
- * It is like a child window, except it is positioned relative to its owning window.
15949
- * It has the ability to listen for {@link OpenFin.ViewEvents View-specific events}.
15950
- *
15951
- * By default, a View will try to share the same renderer process as other Views owned by its parent Application.
15952
- * To change that behavior, see the processAffinity {@link OpenFin.ViewOptions view option}.
15340
+ * By default, a View will try to share the same renderer process as other Views owned by its parent Application.
15341
+ * To change that behavior, see the processAffinity {@link OpenFin.ViewOptions view option}.
15953
15342
  *
15954
15343
  * A View's lifecycle is tied to its owning window and can be re-attached to a different window at any point during its lifecycle.
15955
15344
  */
@@ -16421,7 +15810,7 @@ declare type ViewCreationOrReference = OpenFin.Identity | OpenFin.PlatformViewCr
16421
15810
  */
16422
15811
  declare type ViewDetachedEvent = BaseEvent_5 & {
16423
15812
  type: 'view-detached';
16424
- target: OpenFin.Identity;
15813
+ target: OpenFin.Identity | null;
16425
15814
  previousTarget: OpenFin.Identity;
16426
15815
  viewIdentity: OpenFin.Identity;
16427
15816
  };
@@ -17657,7 +17046,7 @@ declare namespace WebContentsEvents {
17657
17046
  * `clipboard-read`: Request access to read from the clipboard.<br>
17658
17047
  * `clipboard-sanitized-write`: Request access to write to the clipboard.
17659
17048
  */
17660
- declare type WebPermission = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write' | OpenExternalPermission;
17049
+ declare type WebPermission = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write' | 'hid' | 'usb' | OpenExternalPermission;
17661
17050
 
17662
17051
  /**
17663
17052
  * Object representing headers and their values, where the
@@ -17735,476 +17124,6 @@ declare type WillResizeEvent = WillMoveOrResizeEvent & {
17735
17124
  type: 'will-resize';
17736
17125
  };
17737
17126
 
17738
- /**
17739
- * @PORTED
17740
- * @typedef { object } Margins@typedef { object } Margins
17741
- * @property { string } [marginType]
17742
- * Can be `default`, `none`, `printableArea`, or `custom`. If `custom` is chosen,
17743
- * you will also need to specify `top`, `bottom`, `left`, and `right`.
17744
- *
17745
- * @property { number } [top] The top margin of the printed web page, in pixels.
17746
- * @property { number } [bottom] The bottom margin of the printed web page, in pixels.
17747
- * @property { number } [left] The left margin of the printed web page, in pixels.
17748
- * @property { number } [right] The right margin of the printed web page, in pixels.
17749
- */
17750
- /**
17751
- * @PORTED
17752
- * @typedef { object } Dpi@typedef { object } Dpi
17753
- * @property { number } [horizontal] The horizontal dpi
17754
- * @property { number } [vertical] The vertical dpi
17755
- */
17756
- /**
17757
- * @PORTED
17758
- * @typedef { object } PrintOptions@typedef { object } PrintOptions
17759
- * @property { boolean } [silent=false] Don't ask user for print settings.
17760
- * @property { boolean } [printBackground=false] Prints the background color and image of the web page.
17761
- * @property { string } [deviceName=''] Set the printer device name to use.
17762
- * @property { boolean } [color=true] Set whether the printed web page will be in color or grayscale.
17763
- * @property { Margins } [margins] Set margins for the printed web page
17764
- * @property { boolean } [landscape=false] Whether the web page should be printed in landscape mode.
17765
- * @property { number } [scaleFactor] The scale factor of the web page.
17766
- * @property { number } [pagesPerSheet] The number of pages to print per page sheet.
17767
- * @property { boolean } [collate] Whether the web page should be collated.
17768
- * @property { number } [copies] The number of copies of the web page to print.
17769
- * @property { Record<string, number> } [pageRanges] The page range to print. Should have two keys: from and to.
17770
- * @property { string } [duplexMode] Set the duplex mode of the printed web page. Can be simplex, shortEdge, or longEdge.
17771
- * @property { Dpi } [dpi] Set dpi for the printed web page
17772
- */
17773
- /**
17774
- * @REMOVED
17775
- * PrinterInfo interface
17776
- * @typedef { object } PrinterInfo@typedef { object } PrinterInfo
17777
- * @property { string } name Printer Name
17778
- * @property { string } description Printer Description
17779
- * @property { number } status Printer Status
17780
- * @property { boolean } isDefault Indicates that system's default printer
17781
- */
17782
- /**
17783
- * @REMOVED
17784
- * SharedWorkerInfo interface
17785
- * @typedef { object } SharedWorkerInfo@typedef { object } SharedWorkerInfo
17786
- * @property { string } id The unique id of the shared worker.
17787
- * @property { string } url The url of the shared worker.
17788
- */
17789
- /**
17790
- * @PORTED
17791
- * ContentCreationRule interface
17792
- * @typedef { object } ContentCreationRule@typedef { object } ContentCreationRule
17793
- * @property { string } behavior 'view' | 'window' | 'browser' | 'block'
17794
- * @property { string[] } match List of [match patterns](https://developer.chrome.com/extensions/match_patterns).
17795
- * @property { object } options Window creation options or View creation options.
17796
- */
17797
- /**
17798
- * @PORTED
17799
- * @typedef {object} Window~options
17800
- * @summary Window creation options.
17801
- * @desc This is the options object required by {@link Window.create Window.create}.
17802
- *
17803
- * Note that `name` is the only required property — albeit the `url` property is usually provided as well
17804
- * (defaults to `"about:blank"` when omitted).
17805
- *
17806
- * _This jsdoc typedef mirrors the `WindowOptions` TypeScript interface in `@types/openfin`._
17807
- *
17808
- * @property {object} [accelerator]
17809
- * Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
17810
- *
17811
- * @property {boolean} [accelerator.devtools=false]
17812
- * If `true`, enables the devtools keyboard shortcut:<br>
17813
- * `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
17814
- *
17815
- * @property {boolean} [accelerator.reload=false]
17816
- * If `true`, enables the reload keyboard shortcuts:<br>
17817
- * `Ctrl` + `R` _(Windows)_<br>
17818
- * `F5` _(Windows)_<br>
17819
- * `Command` + `R` _(Mac)_
17820
- *
17821
- * @property {boolean} [accelerator.reloadIgnoringCache=false]
17822
- * If `true`, enables the reload-from-source keyboard shortcuts:<br>
17823
- * `Ctrl` + `Shift` + `R` _(Windows)_<br>
17824
- * `Shift` + `F5` _(Windows)_<br>
17825
- * `Command` + `Shift` + `R` _(Mac)_
17826
- *
17827
- * @property {boolean} [accelerator.zoom=false]
17828
- * 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.
17829
- * If `true`, enables the zoom keyboard shortcuts:<br>
17830
- * `Ctrl` + `+` _(Zoom In)_<br>
17831
- * `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
17832
- * `Ctrl` + `NumPad+` _(Zoom In)_<br>
17833
- * `Ctrl` + `-` _(Zoom Out)_<br>
17834
- * `Ctrl` + `Shift` + `-` _(Zoom Out)_<br>
17835
- * `Ctrl` + `NumPad-` _(Zoom Out)_<br>
17836
- * `Ctrl` + `Scroll` _(Zoom In & Out)_<br>
17837
- * `Ctrl` + `0` _(Restore to 100%)_
17838
- *
17839
- * @property {object} [alphaMask] - _Experimental._ _Updatable._
17840
- * <br>
17841
- * alphaMask turns anything of matching RGB value transparent.
17842
- * <br>
17843
- * Caveats:
17844
- * * Runtime flags --disable-gpu and --allow-unsafe-compositing are required. Note: Unclear behavior on remote Desktop support
17845
- * * User cannot click-through transparent regions
17846
- * * Not supported on Mac
17847
- * * Windows Aero must be enabled
17848
- * * Won't make visual sense on Pixel-pushed environments such as Citrix
17849
- * * Not supported on rounded corner windows
17850
- * @property {number} [alphaMask.red=-1] 0-255
17851
- * @property {number} [alphaMask.green=-1] 0-255
17852
- * @property {number} [alphaMask.blue=-1] 0-255
17853
- *
17854
- * @property {boolean} [alwaysOnTop=false] - _Updatable._
17855
- * A flag to always position the window at the top of the window stack.
17856
- *
17857
- * @property {object} [api]
17858
- * Configurations for API injection.
17859
- *
17860
- * @property {object} [api.iframe] Configure if the the API should be injected into iframes based on domain.
17861
- *
17862
- * @property {boolean} [api.iframe.crossOriginInjection=false] Controls if the `fin` API object is present for cross origin iframes.
17863
- * @property {boolean} [api.iframe.sameOriginInjection=true] Controls if the `fin` API object is present for same origin iframes.
17864
- *
17865
- * @property {string} [applicationIcon = ""] - _Deprecated_ - use `icon` instead.
17866
- *
17867
- * @property {number} [aspectRatio=0] - _Updatable._
17868
- * The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
17869
- * an aspect ratio will not be enforced.
17870
- *
17871
- * @property {string} [autoplayPolicy="no-user-gesture-required"]
17872
- * Autoplay policy to apply to content in the window, can be
17873
- * `no-user-gesture-required`, `user-gesture-required`,
17874
- * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
17875
- *
17876
- * @property {boolean} [autoShow=true]
17877
- * A flag to automatically show the window when it is created.
17878
- *
17879
- * @property {string} [backgroundColor="#FFF"]
17880
- * The window’s _backfill_ color as a hexadecimal value. Not to be confused with the content background color
17881
- * (`document.body.style.backgroundColor`),
17882
- * this color briefly fills a window’s (a) content area before its content is loaded as well as (b) newly exposed
17883
- * areas when growing a window. Setting
17884
- * this value to the anticipated content background color can help improve user experience.
17885
- * Default is white.
17886
- *
17887
- * @property {object} [contentCreation]
17888
- * Apply rules that determine how user interaction (`window.open` and links) creates content.
17889
- * @property {ContentCreationRule[]} [contentCreation.rules = []] List of content creation rules.
17890
- *
17891
- * @property {object} [contentNavigation]
17892
- * Restrict navigation to URLs that match an allowed pattern.
17893
- * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
17894
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
17895
- * @property {string[]} [contentNavigation.allowlist=[]] List of allowed URLs.
17896
- * @property {string[]} [contentNavigation.denylist=[]] List of denied URLs.
17897
- *
17898
- * @property {object} [contentRedirect]
17899
- * Restrict redirects to URLs that match an allowed pattern.
17900
- * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
17901
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
17902
- * @property {string[]} [contentRedirect.allowlist=[]] List of allowed URLs.
17903
- * @property {string[]} [contentRedirect.denylist=[]] List of denied URLs.
17904
- *
17905
- * @property {boolean} [contextMenu=true] - _Updatable._
17906
- * A flag to show the context menu when right-clicking on a window.
17907
- * Gives access to the devtools for the window.
17908
- *
17909
- * @property {object} [contextMenuSettings] - _Updatable._
17910
- * Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
17911
- * Configure the context menu when right-clicking on a window.
17912
- * @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
17913
- * @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
17914
- * @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
17915
- *
17916
- * @property {object} [contextMenuOptions] - _Updatable._
17917
- * Configure the context menu when right-clicking on a window. Supported menu items:
17918
- * 'separator'
17919
- * 'cut'
17920
- * 'copy'
17921
- * 'paste'
17922
- * 'spellCheck'
17923
- * 'inspect'
17924
- * 'reload'
17925
- * 'navigateForward'
17926
- * 'navigateBack'
17927
- * 'print'
17928
- * @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
17929
- * @property {string[]} [contextMenuSettings.template=[]] List of context menu items to display on right-click.
17930
- *
17931
- * @property {object} [cornerRounding] - _Updatable._
17932
- * Defines and applies rounded corners for a frameless window. **NOTE:** On macOS corner is not ellipse but circle rounded by the
17933
- * average of _height_ and _width_.
17934
- * @property {number} [cornerRounding.height=0] The height in pixels.
17935
- * @property {number} [cornerRounding.width=0] The width in pixels.
17936
- *
17937
- * @property {any} [customContext=""] - _Updatable. Inheritable._
17938
- * A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
17939
- * is called. If a window in a Platform is trying to update or retrieve its own context, it can use the
17940
- * {@link Platform#setWindowContext Platform.setWindowContext} and {@link Platform#getWindowContext Platform.getWindowContext} calls.
17941
- * _When omitted, _inherits_ from the parent application._
17942
- * As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
17943
- *
17944
- * @property {any} [customData=""] - _Updatable. Inheritable._
17945
- * A field that the user can attach serializable data to be ferried around with the window options.
17946
- * _When omitted, _inherits_ from the parent application._
17947
- *
17948
- * @property {object[]} [customRequestHeaders]
17949
- * Defines list of custom headers for requests sent by the window.
17950
- * @property {string[]} [customRequestHeaders.urlPatterns=[]] The URL patterns for which the headers will be applied
17951
- * @property {object[]} [customRequestHeaders.headers=[]] Objects representing headers and their values,
17952
- * where the object key is the name of header and value at key is the value of the header
17953
- *
17954
- * @property {boolean} [closeOnLastViewRemoved=true] - _Experimental._ _Updatable._
17955
- * Toggling off would keep the Window alive even if all its Views were closed.
17956
- * This is meant for advanced users and should be used with caution.
17957
- * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
17958
- * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
17959
- * ** note ** - This option is ignored in non-Platforms apps.
17960
- *
17961
- * @property {boolean} [defaultCentered=false]
17962
- * Centers the window in the primary monitor. This option overrides `defaultLeft` and `defaultTop`. When `saveWindowState` is `true`,
17963
- * this value will be ignored for subsequent launches in favor of the cached value. **NOTE:** On macOS _defaultCenter_ is
17964
- * somewhat above center vertically.
17965
- *
17966
- * @property {number} [defaultHeight=500]
17967
- * The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
17968
- * in favor of the cached value.
17969
- *
17970
- * @property {number} [defaultLeft=100]
17971
- * The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
17972
- * launches in favor of the cached value.
17973
- *
17974
- * @property {number} [defaultTop=100]
17975
- * The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
17976
- * launches in favor of the cached value.
17977
- *
17978
- * @property {number} [defaultWidth=800]
17979
- * The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
17980
- * launches in favor of the cached value.
17981
- *
17982
- * @property {boolean} [includeInSnapshots=true] - _Updatable._
17983
- * When true, the window will be be included in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
17984
- * inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
17985
- *
17986
- * @property {boolean} [frame=true] - _Updatable._
17987
- * A flag to show the frame.
17988
- *
17989
- * @hidden-property {boolean} [hideOnClose=false] - A flag to allow a window to be hidden when the close button is clicked.
17990
- *
17991
- * @property {object[]} [hotkeys=[]] - _Updatable._
17992
- * Defines the list of hotkeys that will be emitted as a `hotkey` event on the window. For usage example see [example]{@tutorial hotkeys}.
17993
- * Within Platform, OpenFin also implements a set of pre-defined actions called
17994
- * [keyboard commands]{@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands}
17995
- * that can be assigned to a specific hotkey in the platform manifest.
17996
- * @property {string} hotkeys.keys The key combination of the hotkey, i.e. "Ctrl+T"
17997
- * @property {boolean} [hotkeys.preventDefault=false] Whether or not to prevent default key handling before emitting the event
17998
- *
17999
- * @property {string} [icon] - _Updatable. Inheritable._
18000
- * A URL for the icon to be shown in the window title bar and the taskbar.
18001
- * When omitted, inherits from the parent application._
18002
- * note: Window OS caches taskbar icons, therefore an icon change might only be visible after the cache is removed or the uuid is changed.
18003
- *
18004
- * @property {number} [maxHeight=-1] - _Updatable._
18005
- * The maximum height of a window. Will default to the OS defined value if set to -1.
18006
- *
18007
- * @property {boolean} [maximizable=true] - _Updatable._
18008
- * A flag that lets the window be maximized.
18009
- *
18010
- * @property {number} [maxWidth=-1] - _Updatable._
18011
- * The maximum width of a window. Will default to the OS defined value if set to -1.
18012
- *
18013
- * @property {number} [minHeight=0] - _Updatable._
18014
- * The minimum height of a window.
18015
- *
18016
- * @property {boolean} [minimizable=true] - _Updatable._
18017
- * A flag that lets the window be minimized.
18018
- *
18019
- * @property {number} [minWidth=0] - _Updatable._
18020
- * The minimum width of a window.
18021
- *
18022
- * @property {Identity} [modalParentIdentity]
18023
- * Parent identity of a modal window. It will create a modal child window when this option is set.
18024
- *
18025
- * @property {string} name
18026
- * The name of the window.
18027
- *
18028
- * @property {number} [opacity=1.0] - _Updatable._
18029
- * A flag that specifies how transparent the window will be.
18030
- * Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
18031
- * This value is clamped between `0.0` and `1.0`.
18032
- * * In software composition mode, the runtime flag --allow-unsafe-compositing is required.
18033
- *
18034
- * @property {preloadScript[]} [preloadScripts] - _Inheritable_
18035
- * A list of scripts that are eval'ed before other scripts in the page. When omitted, _inherits_
18036
- * from the parent application.
18037
- *
18038
- * @property {string} [processAffinity]
18039
- * A string to attempt to group renderers together. Will only be used if pages are on the same origin.
18040
- *
18041
- * @property {boolean} [resizable=true] - _Updatable._
18042
- * A flag to allow the user to resize the window.
18043
- *
18044
- * @property {object} [resizeRegion] - _Updatable._
18045
- * Defines a region in pixels that will respond to user mouse interaction for resizing a frameless window.
18046
- * @property {number} [resizeRegion.bottomRightCorner=9]
18047
- * The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
18048
- * @property {number} [resizeRegion.size=7]
18049
- * The size in pixels.
18050
- * @property {object} [resizeRegion.sides={top:true,right:true,bottom:true,left:true}]
18051
- * Sides that a window can be resized from.
18052
- *
18053
- * @property {boolean} [saveWindowState=true]
18054
- * A flag to cache the location of the window.
18055
- * ** note ** - This option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
18056
- *
18057
- * @property {boolean} [ignoreSavedWindowState]
18058
- * A flag to ignore previously cached state of the window. It defaults the opposite value of `saveWindowState` to maintain backwards compatibility.
18059
- *
18060
- * @property {boolean} [shadow=false]
18061
- * A flag to display a shadow on frameless windows.
18062
- * `shadow` and `cornerRounding` are mutually exclusive.
18063
- * On Windows 7, Aero theme is required.
18064
- *
18065
- * @property {boolean} [showBackgroundImages=false] - _Updatable._
18066
- * Platforms Only. If true, will show background images in the layout when the Views are hidden.
18067
- * This occurs when the window is resizing or a tab is being dragged within the layout.
18068
- *
18069
- * @property {boolean} [showTaskbarIcon=true] - _Updatable._ _Windows_.
18070
- * A flag to show the window's icon in the taskbar.
18071
- *
18072
- * @property {boolean} [smallWindow=false]
18073
- * A flag to specify a frameless window that can be be created and resized to less than 41x36 px (width x height).
18074
- * _Note: Caveats of small windows are no Aero Snap and drag to/from maximize._
18075
- * _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
18076
- *
18077
- * @property {boolean} [spellCheck=false]
18078
- * Enable spell check in input text fields for the window.
18079
- *
18080
- * @property {string} [state="normal"]
18081
- * The visible state of the window on creation.
18082
- * One of:
18083
- * * `"maximized"`
18084
- * * `"minimized"`
18085
- * * `"normal"`
18086
- *
18087
- * @property {string} [taskbarIcon=string] - Deprecated - use `icon` instead._Windows_.
18088
- *
18089
- * @property {string} [taskbarIconGroup=<application uuid>] - _Windows_.
18090
- * Specify a taskbar group for the window.
18091
- * _If omitted, defaults to app's uuid (`fin.Application.getCurrentSync().identity.uuid`)._
18092
- *
18093
- * @property {string} [url="about:blank"]
18094
- * The URL of the window.
18095
- *
18096
- * @property {string} [uuid=<application uuid>]
18097
- * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
18098
- * If omitted, defaults to the `uuid` of the application spawning the window.
18099
- * If given, must match the `uuid` of the application spawning the window.
18100
- * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
18101
- * really no need to provide it.
18102
- *
18103
- * @property {boolean} [waitForPageLoad=false]
18104
- * When set to `true`, the window will not appear until the `window` object's `load` event fires.
18105
- * When set to `false`, the window will appear immediately without waiting for content to be loaded.
18106
- *
18107
- * @property {ViewVisibility} [viewVisibility]
18108
- * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
18109
- */
18110
- /**
18111
- * @PORTED
18112
- * @typedef {Object} ViewVisibility@typedef {Object} ViewVisibility _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
18113
- * @property {ShowViewsOnWindowResize} [showViewsOnWindowResize] Enables views to be shown when a Platform Window is being resized by the user.
18114
- * @property {ShowViewsOnSplitterDrag} [showViewsOnSplitterDrag] Allows views to be shown when they are resized by the user dragging the splitter between layout stacks.
18115
- * @property {ShowViewsOnTabDrag} [showViewsOnTabDrag] _Supported on Windows Operating Systems only_. Allows views to be shown when the user is dragging a tab around a layout.
18116
- */
18117
- /**
18118
- * @PORTED
18119
- * @typedef {Object} ShowViewsOnWindowResize@typedef {Object} ShowViewsOnWindowResize _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
18120
- * @property {boolean} [enabled=false] Enables or disables showing Views when a Platform Window is being resized.
18121
- * @property {number} [paintIntervalMs=0] Number of miliseconds to wait between view repaints.
18122
- */
18123
- /**
18124
- * @REMOVED
18125
- * @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.
18126
- * @property {boolean} [enabled=false] Enables or disables showing views when the layout splitter is being dragged.
18127
- */
18128
- /**
18129
- * @REMOVED
18130
- * @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.
18131
- * @property {boolean} [enabled=false] Enables or disables showing views when a tab is being dragged.
18132
- */
18133
- /**
18134
- * @PORTED
18135
- * @typedef {object} CapturePageOptions@typedef {object} CapturePageOptions
18136
- * @property { Area } [area] The area of the window to be captured.
18137
- * @property { string } [format='png'] The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
18138
- * @property { number } [quality=100] Number representing quality of JPEG image only. Between 0 - 100.
18139
- */
18140
- /**
18141
- * @PORTED
18142
- * @typedef { object } Area@typedef { object } Area
18143
- * @property { number } height Area's height
18144
- * @property { number } width Area's width
18145
- * @property { number } x X coordinate of area's starting point
18146
- * @property { number } y Y coordinate of area's starting point
18147
- */
18148
- /**
18149
- * @PORTED
18150
- * @typedef {object} FindInPageOptions@typedef {object} FindInPageOptions
18151
- * @property {boolean} [forward=true] Whether to search forward or backward.
18152
- * @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.
18153
- * @property {boolean} [matchCase=false] Whether search should be case-sensitive.
18154
- * @property {boolean} [wordStart=false] Whether to look only at the start of words.
18155
- * @property {boolean} [medialCapitalAsWordStart=false]
18156
- * 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>
18157
- * lowercase or non-letter. Accepts several other intra-word matches.
18158
- */
18159
- /**
18160
- * @REMOVED
18161
- * @typedef {object} Transition@typedef {object} Transition
18162
- * @property {Opacity} opacity - The Opacity transition
18163
- * @property {Position} position - The Position transition
18164
- * @property {Size} size - The Size transition
18165
- */
18166
- /**
18167
- * @PORTED
18168
- * @typedef {object} TransitionOptions@typedef {object} TransitionOptions
18169
- * @property {boolean} interrupt - This option interrupts the current animation. When false it pushes
18170
- this animation onto the end of the animation queue.
18171
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
18172
- */
18173
- /**
18174
- * @PORTED
18175
- * @typedef {object} Size@typedef {object} Size
18176
- * @property {number} duration - The total time in milliseconds this transition should take.
18177
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
18178
- * @property {number} width - Optional if height is present. Defaults to the window's current width.
18179
- * @property {number} height - Optional if width is present. Defaults to the window's current height.
18180
- */
18181
- /**
18182
- * @PORTED
18183
- * @typedef {object} Position@typedef {object} Position
18184
- * @property {number} duration - The total time in milliseconds this transition should take.
18185
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
18186
- * @property {number} left - Defaults to the window's current left position in virtual screen coordinates.
18187
- * @property {number} top - Defaults to the window's current top position in virtual screen coordinates.
18188
- */
18189
- /**
18190
- * @PORTED
18191
- * @typedef {object} Opacity@typedef {object} Opacity
18192
- * @property {number} duration - The total time in milliseconds this transition should take.
18193
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
18194
- * @property {number} opacity - This value is clamped from 0.0 to 1.0.
18195
- */
18196
- /**
18197
- * @REMOVED
18198
- * Bounds is a interface that has the properties of height,
18199
- * width, left, top which are all numbers
18200
- * @typedef { object } Bounds@typedef { object } Bounds
18201
- * @property { number } height Get the application height bound
18202
- * @property { number } width Get the application width bound
18203
- * @property { number } top Get the application top bound
18204
- * @property { number } left Get the application left bound
18205
- * @property { number } right Get the application right bound
18206
- * @property { number } bottom Get the application bottom bound
18207
- */
18208
17127
  /**
18209
17128
  * A basic window that wraps a native HTML window. Provides more fine-grained
18210
17129
  * control over the window state such as the ability to minimize, maximize, restore, etc.
@@ -18990,10 +17909,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
18990
17909
  show(force?: boolean): Promise<void>;
18991
17910
  /**
18992
17911
  * Shows the window if it is hidden at the specified location.
18993
- * If the toggle parameter is set to true, the window will
18994
- * alternate between showing and hiding.
18995
- * @param left The left position of the window
18996
- * @param top The right position of the window
17912
+ *
17913
+ * @param left The left position of the window in pixels
17914
+ * @param top The top position of the window in pixels
18997
17915
  * @param force Show will be prevented from closing when force is false and
18998
17916
  * ‘show-requested’ has been subscribed to for application’s main window
18999
17917
  *
@@ -19055,28 +17973,6 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
19055
17973
  * ```
19056
17974
  */
19057
17975
  authenticate(userName: string, password: string): Promise<void>;
19058
- /**
19059
- * @typedef {object} ShowPopupMenuOptions@typedef {object} ShowPopupMenuOptions
19060
- * @property {Array<MenuItemTemplate>} template - An array describing the menu to show.
19061
- * @property {number} [x] - The window x coordinate where to show the menu. Defaults to mouse position. If using must also use `y`.
19062
- * @property {number} [y] - The window y coordinate where to show the menu. Defaults to mouse position. If using must also use `x`
19063
- */
19064
- /**
19065
- * @typedef {object} MenuItemTemplate@typedef {object} MenuItemTemplate
19066
- * @property {*} data - Data to be returned if the user selects the element. Must be serializable. Large objects can have a performance impact.
19067
- * @property {'normal' | 'separator' | 'submenu' | 'checkbox'} [type] - Defaults to 'normal' unless a 'submenu' key exists
19068
- * @property {string} [label] - The text to show on the menu item. Should be left undefined for `type: 'separator'`
19069
- * @property {boolean} [enabled] - If false, the menu item will be greyed out and unclickable.
19070
- * @property {boolean} [visible] - If false, the menu item will be entirely hidden.
19071
- * @property {boolean} [checked] - Should only be specified for `checkbox` type menu items.
19072
- * @property {string} [icon] - Image Data URI with image dimensions inferred from the encoded string
19073
- * @property {Array<MenuItemTemplate>} [submenu] Should be specified for `submenu` type menu items. If `submenu` is specified, the `type: 'submenu'` can be omitted.
19074
- */
19075
- /**
19076
- * @typedef {object} MenuResult@typedef {object} MenuResult
19077
- * @property {'clicked' | 'closed'} result - Whether the user clicked on a menu item or the menu was closed (user clicked elsewhere).
19078
- * @property {* | undefined} [data] - The data property of the menu item clicked by the user. Only defined if result was `clicked`.
19079
- */
19080
17976
  /**
19081
17977
  * Shows a menu on the window.
19082
17978
  *
@@ -19173,577 +18069,552 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
19173
18069
  */
19174
18070
  closePopupMenu(): Promise<void>;
19175
18071
  /**
19176
- * @PORTED
19177
- * @typedef {object} PopupOptions@typedef {object} PopupOptions
19178
- * @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.
19179
- * @property {string} [url] - Navigates to this `url` if showing an existing window as a popup, otherwise the newly created window will load this `url`.
19180
- * @property {Window~options} [initialOptions] - Window creation options when using `showPopupWindow` to create a new window.
19181
- * @property {Window~options} [additionalOptions] - Updatable window options applied to new and existing windows when shown as popups.
19182
- * @property {function} [onPopupResult] - Executed when this window's popup calls `dispatchPopupResult`. Note: if this is defined, `showPopupWindow` will not return a `PopupResult`.
19183
- * @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.
19184
- * @property {number} [height] - Height of the popup window (takes priority over `intialOptions` size properties).
19185
- * @property {number} [width] - Width of the popup window (takes priority over `intialOptions` size properties).
19186
- * @property {number} [x] - Left position where the popup window will be shown (relative to the window calling `showPopupWindow`).
19187
- * @property {number} [y] - Top position where the popup window will be shown (relative to the window calling `showPopupWindow`).
19188
- * @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.
19189
- * @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`.
19190
- * @property {boolean} [focus] - Determines if the popup window should or should not be focused when it is shown.
19191
- * @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.
19192
- */
19193
- /**
19194
- * @PORTED
19195
- * @typedef {object} PopupResult@typedef {object} PopupResult
19196
- * @property {Identity} identity - `name` and `uuid` of the popup window that called dispatched this result.
19197
- * @property {'clicked' | 'dismissed'} result - Result of the user interaction with the popup window.
19198
- * @property {* | undefined} [data] - Data passed to `dispatchPopupResult`.
19199
- */
19200
- /**
19201
- * Dispatch a result to the caller of `showPopupWindow`.
19202
- *
19203
- * @remarks If this window isn't currently being shown as a popup, this call will silently fail.
19204
- * @param data Serializable data to send to the caller window.
19205
- *
19206
- * @example
19207
- * ```js
19208
- * await fin.me.dispatchPopupResult({
19209
- * foo: 'bar'
19210
- * });
19211
- * ```
19212
- */
19213
- dispatchPopupResult(data: any): Promise<void>;
19214
- /**
19215
- * Prints the contents of the window.
19216
- *
19217
- * @param options Configuration for the print task.
19218
- * @remarks When `silent` is set to `true`, the API will pick the system's default printer if deviceName is empty
19219
- * and the default settings for printing.
19220
- *
19221
- * Use the CSS style `page-break-before: always;` to force print to a new page.
19222
- *
19223
- * @example
19224
- * ```js
19225
- * const win = fin.Window.getCurrentSync();
19226
- *
19227
- * win.print({ silent: false, deviceName: 'system-printer-name' }).then(() => {
19228
- * console.log('print call has been sent to the system');
19229
- * });
19230
- * ```
19231
- *
19232
- * If a window has embedded views, those views will not print by default. To print a window's contents including embedded views,
19233
- * use the `content` option:
19234
- *
19235
- * ```js
19236
- * const win = fin.Window.getCurrentSync();
19237
- *
19238
- * // Print embedded views
19239
- * win.print({ content: 'views' });
19240
- *
19241
- * // Print screenshot of current window
19242
- * win.print({ content: 'screenshot' })
19243
- * ```
19244
- *
19245
- * When `content` is set to `views`, the embedded views in the platform window will be concatenated and printed as
19246
- * individual pages. If `includeSelf` is set to `true`, the platform window itself will be printed as the first
19247
- * page - be aware that this page will *not* include the embedded views - it will only include the contents of
19248
- * the platform window itself (e.g. tab stacks), with blank spaces where the view contents would be embedded.
19249
- *
19250
- * Due to a known issue, view contents that are not visible at the time `print` is called will not appear when
19251
- * printing `contents: views`. This includes views that are obscured behind other active UI elements.
19252
- *
19253
- * To print the views embedded in their page context, set `content` to `screenshot`.
19254
- */
19255
- print(options?: OpenFin.WindowPrintOptions): Promise<void>;
19256
- }
19257
-
19258
- /**
19259
- * Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
19260
- * @interface
19261
- */
19262
- declare type WindowAlertRequestedEvent = BaseEvent_3 & {
19263
- type: 'window-alert-requested';
19264
- };
19265
-
19266
- /**
19267
- * Returned from getBounds call. bottom and right are never used for setting.
19268
- * @interface
19269
- */
19270
- declare type WindowBounds = Bounds & {
19271
- bottom: number;
19272
- right: number;
19273
- };
19274
-
19275
- /**
19276
- * @deprecated Renamed to {@link ClosedEvent}.
19277
- */
19278
- declare type WindowClosedEvent = ClosedEvent_2;
19279
-
19280
- /**
19281
- * @deprecated Renamed to {@link CloseRequestedEvent}.
19282
- */
19283
- declare type WindowCloseRequestedEvent = CloseRequestedEvent;
19284
-
19285
- /**
19286
- * @deprecated Renamed to {@link ClosingEvent}.
19287
- */
19288
- declare type WindowClosingEvent = ClosingEvent;
19289
-
19290
- /**
19291
- * A rule prescribing content creation in a {@link OpenFin.Window}.
19292
- *
19293
- * @interface
19294
- */
19295
- declare type WindowContentCreationRule = BaseContentCreationRule & {
19296
- /**
19297
- * Behavior to use when opening matched content.
19298
- */
19299
- behavior: 'window';
19300
- /**
19301
- * Options for newly-created window.
19302
- */
19303
- options?: Partial<WindowOptions>;
19304
- };
19305
-
19306
- /**
19307
- * Generated when a child window is created.
19308
- * @interface
19309
- */
19310
- declare type WindowCreatedEvent = BaseEvent_3 & {
19311
- type: 'window-created';
19312
- };
19313
-
19314
- /**
19315
- * Options required to create a new window with {@link Window._WindowModule.create Window.create}.
19316
- *
19317
- * Note that `name` is the only required property — albeit the `url` property is usually provided as well
19318
- * (defaults to `"about:blank"` when omitted).
19319
- * @interface
19320
- */
19321
- declare type WindowCreationOptions = Partial<WindowOptions> & {
19322
- name: string;
19323
- };
19324
-
19325
- declare type WindowCreationReason = 'tearout' | 'create-view-without-target' | 'api-call' | 'app-creation' | 'restore' | 'apply-snapshot';
19326
-
19327
- /**
19328
- * @interface
19329
- */
19330
- declare type WindowDetail = {
19331
- /**
19332
- * The bottom-most coordinate of the window.
19333
- */
19334
- bottom: number;
19335
- /**
19336
- * The height of the window.
19337
- */
19338
- height: number;
19339
- isShowing: boolean;
19340
- /**
19341
- * The left-most coordinate of the window.
19342
- */
19343
- left: number;
19344
- /**
19345
- * The name of the window.
19346
- */
19347
- name: string;
19348
- /**
19349
- * The right-most coordinate of the window.
19350
- */
19351
- right: number;
19352
- state: string;
19353
- /**
19354
- * The top-most coordinate of the window.
19355
- */
19356
- top: number;
19357
- /**
19358
- * The width of the window.
19359
- */
19360
- width: number;
19361
- };
19362
-
19363
- /**
19364
- * Generated when a child window ends loading.
19365
- * @interface
19366
- */
19367
- declare type WindowEndLoadEvent = BaseEvent_3 & {
19368
- type: 'window-end-load';
19369
- };
19370
-
19371
- /**
19372
- * @deprecated, Renamed to {@link Event}.
19373
- */
19374
- declare type WindowEvent = Event_6;
19375
-
19376
- declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
19377
-
19378
- declare namespace WindowEvents {
19379
- export {
19380
- BaseEvent_5 as BaseEvent,
19381
- BaseWindowEvent,
19382
- ViewAttachedEvent,
19383
- ViewDetachedEvent,
19384
- WindowViewEvent,
19385
- AlertRequestedEvent,
19386
- AuthRequestedEvent,
19387
- EndLoadEvent,
19388
- WillRedirectEvent,
19389
- ReloadedEvent,
19390
- OptionsChangedEvent,
19391
- WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
19392
- ExternalProcessExitedEvent,
19393
- ExternalProcessStartedEvent,
19394
- HiddenEvent_2 as HiddenEvent,
19395
- WindowHiddenEvent,
19396
- PreloadScriptInfoRunning,
19397
- PreloadScriptInfo,
19398
- PreloadScriptsStateChangeEvent,
19399
- UserBoundsChangeEvent,
19400
- BoundsChangeEvent,
19401
- WillMoveOrResizeEvent,
19402
- PerformanceReportEvent,
19403
- InputEvent_2 as InputEvent,
19404
- LayoutInitializedEvent,
19405
- LayoutReadyEvent,
19406
- BeginUserBoundsChangingEvent,
19407
- BoundsChangedEvent,
19408
- BoundsChangingEvent,
19409
- CloseRequestedEvent,
19410
- WindowCloseRequestedEvent,
19411
- ContextChangedEvent,
19412
- ClosedEvent_2 as ClosedEvent,
19413
- WindowClosedEvent,
19414
- ClosingEvent,
19415
- WindowClosingEvent,
19416
- DisabledMovementBoundsChangedEvent,
19417
- DisabledMovementBoundsChangingEvent,
19418
- EmbeddedEvent,
19419
- EndUserBoundsChangingEvent,
19420
- HotkeyEvent_2 as HotkeyEvent,
19421
- WindowHotkeyEvent,
19422
- InitializedEvent_2 as InitializedEvent,
19423
- WindowInitializedEvent,
19424
- MaximizedEvent,
19425
- MinimizedEvent,
19426
- PreloadScriptsStateChangedEvent,
19427
- PreloadScriptsStateChangingEvent,
19428
- RestoredEvent,
19429
- WindowRestoredEvent,
19430
- ShowRequestedEvent,
19431
- WindowShowRequestedEvent,
19432
- ShownEvent_2 as ShownEvent,
19433
- WindowShownEvent,
19434
- UserMovementEnabledEvent,
19435
- UserMovementDisabledEvent,
19436
- WillMoveEvent,
19437
- WillResizeEvent,
19438
- NonPropagatedWindowEvent,
19439
- ShowAllDownloadsEvent,
19440
- DownloadShelfVisibilityChangedEvent,
19441
- WindowSourcedEvent,
19442
- WillPropagateWindowEvent,
19443
- Event_6 as Event,
19444
- WindowEvent,
19445
- EventType_2 as EventType,
19446
- WindowEventType,
19447
- PropagatedEvent_3 as PropagatedEvent,
19448
- PropagatedWindowEvent,
19449
- PropagatedWindowEventType,
19450
- Payload_3 as Payload,
19451
- ByType_2 as ByType
19452
- }
19453
- }
19454
-
19455
- /**
19456
- * @deprecated Renamed to {@link EventType}.
19457
- */
19458
- declare type WindowEventType = WindowEvent['type'];
19459
-
19460
- /**
19461
- * @deprecated Renamed to {@link HiddenEvent}.
19462
- */
19463
- declare type WindowHiddenEvent = HiddenEvent_2;
19464
-
19465
- /**
19466
- * @deprecated Renamed to {@link HotkeyEvent}.
19467
- */
19468
- declare type WindowHotkeyEvent = HotkeyEvent_2;
19469
-
19470
- /**
19471
- * @interface
19472
- */
19473
- declare type WindowInfo = {
19474
- canNavigateBack: boolean;
19475
- canNavigateForward: boolean;
19476
- preloadScripts: Array<any>;
19477
- title: string;
19478
- url: string;
19479
- };
19480
-
19481
- /**
19482
- * @deprecated Renamed to {@link InitializedEvent}.
19483
- */
19484
- declare type WindowInitializedEvent = InitializedEvent_2;
19485
-
19486
- /**
19487
- * Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
19488
- */
19489
- declare class _WindowModule extends Base {
19490
- /**
19491
- * Asynchronously returns a Window object that represents an existing window.
19492
- *
19493
- * @example
19494
- * ```js
19495
- * async function createWin() {
19496
- * const app = await fin.Application.start({
19497
- * name: 'myApp',
19498
- * uuid: 'app-1',
19499
- * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrap.html',
19500
- * autoShow: true
19501
- * });
19502
- * return await app.getWindow();
19503
- * }
19504
- * createWin().then(() => fin.Window.wrap({ uuid: 'app-1', name: 'myApp' }))
19505
- * .then(win => console.log('wrapped window'))
19506
- * .catch(err => console.log(err));
19507
- * ```
19508
- */
19509
- wrap(identity: OpenFin.Identity): Promise<OpenFin.Window>;
19510
- /**
19511
- * Synchronously returns a Window object that represents an existing window.
19512
- *
19513
- * @example
19514
- * ```js
19515
- * async function createWin() {
19516
- * const app = await fin.Application.start({
19517
- * name: 'myApp',
19518
- * uuid: 'app-1',
19519
- * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrapSync.html',
19520
- * autoShow: true
19521
- * });
19522
- * return await app.getWindow();
19523
- * }
19524
- * await createWin();
19525
- * let win = fin.Window.wrapSync({ uuid: 'app-1', name: 'myApp' });
19526
- * ```
19527
- */
19528
- wrapSync(identity: OpenFin.Identity): OpenFin.Window;
19529
- /**
19530
- * Creates a new Window.
19531
- * @param options - Window creation options
19532
- *
19533
- * @example
19534
- * ```js
19535
- * async function createWindow() {
19536
- * const winOption = {
19537
- * name:'child',
19538
- * defaultWidth: 300,
19539
- * defaultHeight: 300,
19540
- * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.create.html',
19541
- * frame: true,
19542
- * autoShow: true
19543
- * };
19544
- * return await fin.Window.create(winOption);
19545
- * }
19546
- *
19547
- * createWindow().then(() => console.log('Window is created')).catch(err => console.log(err));
19548
- * ```
19549
- */
19550
- create(options: OpenFin.WindowCreationOptions): Promise<OpenFin.Window>;
19551
- /**
19552
- * Asynchronously returns a Window object that represents the current window
19553
- *
19554
- * @example
19555
- * ```js
19556
- * fin.Window.getCurrent()
19557
- * .then(wnd => console.log('current window'))
19558
- * .catch(err => console.log(err));
19559
- *
19560
- * ```
19561
- */
19562
- getCurrent(): Promise<OpenFin.Window>;
19563
- /**
19564
- * Synchronously returns a Window object that represents the current window
19565
- *
19566
- * @example
19567
- * ```js
19568
- * const wnd = fin.Window.getCurrentSync();
19569
- * const info = await wnd.getInfo();
19570
- * console.log(info);
19571
- *
19572
- * ```
19573
- */
19574
- getCurrentSync(): OpenFin.Window;
19575
- }
19576
-
19577
- /**
19578
- * Generated when a child window is not responding.
19579
- * @interface
19580
- */
19581
- declare type WindowNotRespondingEvent = BaseEvent_3 & {
19582
- type: 'window-not-responding';
19583
- };
19584
-
19585
- /**
19586
- * @interface
19587
- */
19588
- declare type WindowOptionDiff = {
19589
- [key in keyof WindowOptions]: {
19590
- oldVal: WindowOptions[key];
19591
- newVal: WindowOptions[key];
19592
- };
19593
- };
19594
-
19595
- /**
19596
- * @interface
19597
- */
19598
- declare type WindowOptions = MutableWindowOptions & ConstWindowOptions;
19599
-
19600
- declare type WindowOptionsChangedEvent = OpenFin.WindowEvents.WindowOptionsChangedEvent;
19601
-
19602
- /**
19603
- * @deprecated Renamed to {@link OptionsChangedEvent}.
19604
- */
19605
- declare type WindowOptionsChangedEvent_2 = OptionsChangedEvent;
19606
-
19607
- declare type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
19608
-
19609
- /**
19610
- * Generated when a child window is responding.
19611
- * @interface
19612
- */
19613
- declare type WindowRespondingEvent = BaseEvent_3 & {
19614
- type: 'window-responding';
19615
- };
19616
-
19617
- /**
19618
- * @deprecated Renamed to {@link RestoredEvent}.
19619
- */
19620
- declare type WindowRestoredEvent = RestoredEvent;
19621
-
19622
- /**
19623
- * @deprecated Renamed to {@link ShownEvent}.
19624
- */
19625
- declare type WindowShownEvent = ShownEvent_2;
19626
-
19627
- /**
19628
- * @deprecated Renamed to {@link ShowRequestedEvent}.
19629
- */
19630
- declare type WindowShowRequestedEvent = ShowRequestedEvent;
19631
-
19632
- /**
19633
- * A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
19634
- * from {@link OpenFin.ViewEvents}.
19635
- */
19636
- 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;
19637
-
19638
- /**
19639
- * Generated when a child window starts loading.
19640
- * @interface
19641
- */
19642
- declare type WindowStartLoadEvent = BaseEvent_3 & {
19643
- type: 'window-start-load';
19644
- };
19645
-
19646
- /**
19647
- * Visibility state of a window.
19648
- */
19649
- declare type WindowState = 'maximized' | 'minimized' | 'normal';
19650
-
19651
- /**
19652
- * A view-related event that fires natively on the `Window` topic. This means that these events *do* propagate
19653
- * to the `Application` level, with the name pattern `window-view-eventname`.
19654
- */
19655
- declare type WindowViewEvent = {
19656
- viewIdentity: OpenFin.Identity;
19657
- } & (ViewAttachedEvent | ViewDetachedEvent);
19658
-
19659
- /**
19660
- * @interface
19661
- */
19662
- declare type WindowViewsPrintOptions = {
19663
- content: 'views';
19664
- includeSelf?: boolean;
19665
- };
19666
-
19667
- declare type Wire = EventEmitter & {
19668
- connect(messageReciever: MessageReceiver): Promise<any>;
19669
- connectSync(): any;
19670
- send(data: any): Promise<any>;
19671
- shutdown(): Promise<void>;
19672
- getPort(): string;
19673
- };
19674
-
19675
- declare type WireConstructor = {
19676
- new (onmessage: (data: any) => void): Wire;
19677
- };
19678
-
19679
- /* Excluded from this release type: WithId */
19680
-
19681
- declare interface WithInterop {
19682
- interop: InteropClient;
19683
- }
19684
-
19685
- /* Excluded from this release type: WithoutId */
19686
-
19687
- declare type WithPositioningOptions<T extends {} = {}> = T & {
19688
- positioningOptions?: OpenFin.PositioningOptions;
19689
- };
19690
-
19691
- /* Excluded from this release type: WorkspacePlatformOptions */
19692
-
19693
- /**
19694
- * A generic request to write any supported data to the clipboard.
19695
- * @interface
19696
- */
19697
- declare type WriteAnyClipboardRequest = BaseClipboardRequest & {
19698
- /**
19699
- * Data to be written
19700
- */
19701
- data: {
19702
- text?: string;
19703
- html?: string;
19704
- rtf?: string;
19705
- } & Partial<Pick<WriteImageClipboardRequest, 'image'>>;
19706
- };
19707
-
19708
- /**
19709
- * @deprecated - instead use WriteAnyClipboardRequest
19710
- *
19711
- * A generic request to write any supported data to the clipboard.
19712
- *
19713
- * @interface
19714
- */
19715
- declare type WriteAnyRequestType = WriteAnyClipboardRequest;
19716
-
19717
- /**
19718
- * A request to write data to the clipboard.
19719
- * @interface
19720
- */
19721
- declare type WriteClipboardRequest = BaseClipboardRequest & {
19722
- /**
19723
- * Data to write to the clipboard.
19724
- */
19725
- data: string;
19726
- };
19727
-
19728
- /**
19729
- * @interface
19730
- */
19731
- declare type WriteImageClipboardRequest = BaseClipboardRequest & {
19732
- /**
19733
- * Can be either a base64 string, or a DataURL string. If using DataURL, the
19734
- * supported formats are `data:image/png[;base64],` and `data:image/jpeg[;base64],`.
19735
- * Using other image/<format> DataURLs will throw an Error.
19736
- */
19737
- image: string;
19738
- };
19739
-
19740
- /**
19741
- * @deprecated - instead use OpenFin.WriteClipboardRequest
19742
- *
19743
- * A request to write data to the clipboard.
19744
- *
19745
- * @interface
19746
- */
19747
- declare type WriteRequestType = WriteClipboardRequest;
19748
-
19749
- export { }
18072
+ * Dispatch a result to the caller of `showPopupWindow`.
18073
+ *
18074
+ * @remarks If this window isn't currently being shown as a popup, this call will silently fail.
18075
+ * @param data Serializable data to send to the caller window.
18076
+ *
18077
+ * @example
18078
+ * ```js
18079
+ * await fin.me.dispatchPopupResult({
18080
+ * foo: 'bar'
18081
+ * });
18082
+ * ```
18083
+ */
18084
+ dispatchPopupResult(data: any): Promise<void>;
18085
+ /**
18086
+ * Prints the contents of the window.
18087
+ *
18088
+ * @param options Configuration for the print task.
18089
+ * @remarks When `silent` is set to `true`, the API will pick the system's default printer if deviceName is empty
18090
+ * and the default settings for printing.
18091
+ *
18092
+ * Use the CSS style `page-break-before: always;` to force print to a new page.
18093
+ *
18094
+ * @example
18095
+ * ```js
18096
+ * const win = fin.Window.getCurrentSync();
18097
+ *
18098
+ * win.print({ silent: false, deviceName: 'system-printer-name' }).then(() => {
18099
+ * console.log('print call has been sent to the system');
18100
+ * });
18101
+ * ```
18102
+ *
18103
+ * If a window has embedded views, those views will not print by default. To print a window's contents including embedded views,
18104
+ * use the `content` option:
18105
+ *
18106
+ * ```js
18107
+ * const win = fin.Window.getCurrentSync();
18108
+ *
18109
+ * // Print embedded views
18110
+ * win.print({ content: 'views' });
18111
+ *
18112
+ * // Print screenshot of current window
18113
+ * win.print({ content: 'screenshot' })
18114
+ * ```
18115
+ *
18116
+ * When `content` is set to `views`, the embedded views in the platform window will be concatenated and printed as
18117
+ * individual pages. If `includeSelf` is set to `true`, the platform window itself will be printed as the first
18118
+ * page - be aware that this page will *not* include the embedded views - it will only include the contents of
18119
+ * the platform window itself (e.g. tab stacks), with blank spaces where the view contents would be embedded.
18120
+ *
18121
+ * Due to a known issue, view contents that are not visible at the time `print` is called will not appear when
18122
+ * printing `contents: views`. This includes views that are obscured behind other active UI elements.
18123
+ *
18124
+ * To print the views embedded in their page context, set `content` to `screenshot`.
18125
+ */
18126
+ print(options?: OpenFin.WindowPrintOptions): Promise<void>;
18127
+ }
18128
+
18129
+ /**
18130
+ * Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
18131
+ * @interface
18132
+ */
18133
+ declare type WindowAlertRequestedEvent = BaseEvent_3 & {
18134
+ type: 'window-alert-requested';
18135
+ };
18136
+
18137
+ /**
18138
+ * Returned from getBounds call. bottom and right are never used for setting.
18139
+ * @interface
18140
+ */
18141
+ declare type WindowBounds = Bounds & {
18142
+ bottom: number;
18143
+ right: number;
18144
+ };
18145
+
18146
+ /**
18147
+ * @deprecated Renamed to {@link ClosedEvent}.
18148
+ */
18149
+ declare type WindowClosedEvent = ClosedEvent_2;
18150
+
18151
+ /**
18152
+ * @deprecated Renamed to {@link CloseRequestedEvent}.
18153
+ */
18154
+ declare type WindowCloseRequestedEvent = CloseRequestedEvent;
18155
+
18156
+ /**
18157
+ * @deprecated Renamed to {@link ClosingEvent}.
18158
+ */
18159
+ declare type WindowClosingEvent = ClosingEvent;
18160
+
18161
+ /**
18162
+ * A rule prescribing content creation in a {@link OpenFin.Window}.
18163
+ *
18164
+ * @interface
18165
+ */
18166
+ declare type WindowContentCreationRule = BaseContentCreationRule & {
18167
+ /**
18168
+ * Behavior to use when opening matched content.
18169
+ */
18170
+ behavior: 'window';
18171
+ /**
18172
+ * Options for newly-created window.
18173
+ */
18174
+ options?: Partial<WindowOptions>;
18175
+ };
18176
+
18177
+ /**
18178
+ * Generated when a child window is created.
18179
+ * @interface
18180
+ */
18181
+ declare type WindowCreatedEvent = BaseEvent_3 & {
18182
+ type: 'window-created';
18183
+ };
18184
+
18185
+ /**
18186
+ * Options required to create a new window with {@link Window._WindowModule.create Window.create}.
18187
+ *
18188
+ * Note that `name` is the only required property — albeit the `url` property is usually provided as well
18189
+ * (defaults to `"about:blank"` when omitted).
18190
+ * @interface
18191
+ */
18192
+ declare type WindowCreationOptions = Partial<WindowOptions> & {
18193
+ name: string;
18194
+ };
18195
+
18196
+ declare type WindowCreationReason = 'tearout' | 'create-view-without-target' | 'api-call' | 'app-creation' | 'restore' | 'apply-snapshot';
18197
+
18198
+ /**
18199
+ * @interface
18200
+ */
18201
+ declare type WindowDetail = {
18202
+ /**
18203
+ * The bottom-most coordinate of the window.
18204
+ */
18205
+ bottom: number;
18206
+ /**
18207
+ * The height of the window.
18208
+ */
18209
+ height: number;
18210
+ isShowing: boolean;
18211
+ /**
18212
+ * The left-most coordinate of the window.
18213
+ */
18214
+ left: number;
18215
+ /**
18216
+ * The name of the window.
18217
+ */
18218
+ name: string;
18219
+ /**
18220
+ * The right-most coordinate of the window.
18221
+ */
18222
+ right: number;
18223
+ state: string;
18224
+ /**
18225
+ * The top-most coordinate of the window.
18226
+ */
18227
+ top: number;
18228
+ /**
18229
+ * The width of the window.
18230
+ */
18231
+ width: number;
18232
+ };
18233
+
18234
+ /**
18235
+ * Generated when a child window ends loading.
18236
+ * @interface
18237
+ */
18238
+ declare type WindowEndLoadEvent = BaseEvent_3 & {
18239
+ type: 'window-end-load';
18240
+ };
18241
+
18242
+ /**
18243
+ * @deprecated, Renamed to {@link Event}.
18244
+ */
18245
+ declare type WindowEvent = Event_6;
18246
+
18247
+ declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
18248
+
18249
+ declare namespace WindowEvents {
18250
+ export {
18251
+ BaseEvent_5 as BaseEvent,
18252
+ BaseWindowEvent,
18253
+ ViewAttachedEvent,
18254
+ ViewDetachedEvent,
18255
+ WindowViewEvent,
18256
+ AlertRequestedEvent,
18257
+ AuthRequestedEvent,
18258
+ EndLoadEvent,
18259
+ WillRedirectEvent,
18260
+ ReloadedEvent,
18261
+ OptionsChangedEvent,
18262
+ WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
18263
+ ExternalProcessExitedEvent,
18264
+ ExternalProcessStartedEvent,
18265
+ HiddenEvent_2 as HiddenEvent,
18266
+ WindowHiddenEvent,
18267
+ PreloadScriptInfoRunning,
18268
+ PreloadScriptInfo,
18269
+ PreloadScriptsStateChangeEvent,
18270
+ UserBoundsChangeEvent,
18271
+ BoundsChangeEvent,
18272
+ WillMoveOrResizeEvent,
18273
+ PerformanceReportEvent,
18274
+ InputEvent_2 as InputEvent,
18275
+ LayoutInitializedEvent,
18276
+ LayoutReadyEvent,
18277
+ BeginUserBoundsChangingEvent,
18278
+ BoundsChangedEvent,
18279
+ BoundsChangingEvent,
18280
+ CloseRequestedEvent,
18281
+ WindowCloseRequestedEvent,
18282
+ ContextChangedEvent,
18283
+ ClosedEvent_2 as ClosedEvent,
18284
+ WindowClosedEvent,
18285
+ ClosingEvent,
18286
+ WindowClosingEvent,
18287
+ DisabledMovementBoundsChangedEvent,
18288
+ DisabledMovementBoundsChangingEvent,
18289
+ EmbeddedEvent,
18290
+ EndUserBoundsChangingEvent,
18291
+ HotkeyEvent_2 as HotkeyEvent,
18292
+ WindowHotkeyEvent,
18293
+ InitializedEvent_2 as InitializedEvent,
18294
+ WindowInitializedEvent,
18295
+ MaximizedEvent,
18296
+ MinimizedEvent,
18297
+ PreloadScriptsStateChangedEvent,
18298
+ PreloadScriptsStateChangingEvent,
18299
+ RestoredEvent,
18300
+ WindowRestoredEvent,
18301
+ ShowRequestedEvent,
18302
+ WindowShowRequestedEvent,
18303
+ ShownEvent_2 as ShownEvent,
18304
+ WindowShownEvent,
18305
+ UserMovementEnabledEvent,
18306
+ UserMovementDisabledEvent,
18307
+ WillMoveEvent,
18308
+ WillResizeEvent,
18309
+ NonPropagatedWindowEvent,
18310
+ ShowAllDownloadsEvent,
18311
+ DownloadShelfVisibilityChangedEvent,
18312
+ WindowSourcedEvent,
18313
+ WillPropagateWindowEvent,
18314
+ Event_6 as Event,
18315
+ WindowEvent,
18316
+ EventType_2 as EventType,
18317
+ WindowEventType,
18318
+ PropagatedEvent_3 as PropagatedEvent,
18319
+ PropagatedWindowEvent,
18320
+ PropagatedWindowEventType,
18321
+ Payload_3 as Payload,
18322
+ ByType_2 as ByType
18323
+ }
18324
+ }
18325
+
18326
+ /**
18327
+ * @deprecated Renamed to {@link EventType}.
18328
+ */
18329
+ declare type WindowEventType = WindowEvent['type'];
18330
+
18331
+ /**
18332
+ * @deprecated Renamed to {@link HiddenEvent}.
18333
+ */
18334
+ declare type WindowHiddenEvent = HiddenEvent_2;
18335
+
18336
+ /**
18337
+ * @deprecated Renamed to {@link HotkeyEvent}.
18338
+ */
18339
+ declare type WindowHotkeyEvent = HotkeyEvent_2;
18340
+
18341
+ /**
18342
+ * @interface
18343
+ */
18344
+ declare type WindowInfo = {
18345
+ canNavigateBack: boolean;
18346
+ canNavigateForward: boolean;
18347
+ preloadScripts: Array<any>;
18348
+ title: string;
18349
+ url: string;
18350
+ };
18351
+
18352
+ /**
18353
+ * @deprecated Renamed to {@link InitializedEvent}.
18354
+ */
18355
+ declare type WindowInitializedEvent = InitializedEvent_2;
18356
+
18357
+ /**
18358
+ * Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
18359
+ */
18360
+ declare class _WindowModule extends Base {
18361
+ /**
18362
+ * Asynchronously returns a Window object that represents an existing window.
18363
+ *
18364
+ * @example
18365
+ * ```js
18366
+ * async function createWin() {
18367
+ * const app = await fin.Application.start({
18368
+ * name: 'myApp',
18369
+ * uuid: 'app-1',
18370
+ * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrap.html',
18371
+ * autoShow: true
18372
+ * });
18373
+ * return await app.getWindow();
18374
+ * }
18375
+ * createWin().then(() => fin.Window.wrap({ uuid: 'app-1', name: 'myApp' }))
18376
+ * .then(win => console.log('wrapped window'))
18377
+ * .catch(err => console.log(err));
18378
+ * ```
18379
+ */
18380
+ wrap(identity: OpenFin.Identity): Promise<OpenFin.Window>;
18381
+ /**
18382
+ * Synchronously returns a Window object that represents an existing window.
18383
+ *
18384
+ * @example
18385
+ * ```js
18386
+ * async function createWin() {
18387
+ * const app = await fin.Application.start({
18388
+ * name: 'myApp',
18389
+ * uuid: 'app-1',
18390
+ * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrapSync.html',
18391
+ * autoShow: true
18392
+ * });
18393
+ * return await app.getWindow();
18394
+ * }
18395
+ * await createWin();
18396
+ * let win = fin.Window.wrapSync({ uuid: 'app-1', name: 'myApp' });
18397
+ * ```
18398
+ */
18399
+ wrapSync(identity: OpenFin.Identity): OpenFin.Window;
18400
+ /**
18401
+ * Creates a new Window.
18402
+ * @param options - Window creation options
18403
+ *
18404
+ * @example
18405
+ * ```js
18406
+ * async function createWindow() {
18407
+ * const winOption = {
18408
+ * name:'child',
18409
+ * defaultWidth: 300,
18410
+ * defaultHeight: 300,
18411
+ * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.create.html',
18412
+ * frame: true,
18413
+ * autoShow: true
18414
+ * };
18415
+ * return await fin.Window.create(winOption);
18416
+ * }
18417
+ *
18418
+ * createWindow().then(() => console.log('Window is created')).catch(err => console.log(err));
18419
+ * ```
18420
+ */
18421
+ create(options: OpenFin.WindowCreationOptions): Promise<OpenFin.Window>;
18422
+ /**
18423
+ * Asynchronously returns a Window object that represents the current window
18424
+ *
18425
+ * @example
18426
+ * ```js
18427
+ * fin.Window.getCurrent()
18428
+ * .then(wnd => console.log('current window'))
18429
+ * .catch(err => console.log(err));
18430
+ *
18431
+ * ```
18432
+ */
18433
+ getCurrent(): Promise<OpenFin.Window>;
18434
+ /**
18435
+ * Synchronously returns a Window object that represents the current window
18436
+ *
18437
+ * @example
18438
+ * ```js
18439
+ * const wnd = fin.Window.getCurrentSync();
18440
+ * const info = await wnd.getInfo();
18441
+ * console.log(info);
18442
+ *
18443
+ * ```
18444
+ */
18445
+ getCurrentSync(): OpenFin.Window;
18446
+ }
18447
+
18448
+ /**
18449
+ * Generated when a child window is not responding.
18450
+ * @interface
18451
+ */
18452
+ declare type WindowNotRespondingEvent = BaseEvent_3 & {
18453
+ type: 'window-not-responding';
18454
+ };
18455
+
18456
+ /**
18457
+ * @interface
18458
+ */
18459
+ declare type WindowOptionDiff = {
18460
+ [key in keyof WindowOptions]: {
18461
+ oldVal: WindowOptions[key];
18462
+ newVal: WindowOptions[key];
18463
+ };
18464
+ };
18465
+
18466
+ /**
18467
+ * @interface
18468
+ */
18469
+ declare type WindowOptions = MutableWindowOptions & ConstWindowOptions;
18470
+
18471
+ declare type WindowOptionsChangedEvent = OpenFin.WindowEvents.WindowOptionsChangedEvent;
18472
+
18473
+ /**
18474
+ * @deprecated Renamed to {@link OptionsChangedEvent}.
18475
+ */
18476
+ declare type WindowOptionsChangedEvent_2 = OptionsChangedEvent;
18477
+
18478
+ declare type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
18479
+
18480
+ /**
18481
+ * Generated when a child window is responding.
18482
+ * @interface
18483
+ */
18484
+ declare type WindowRespondingEvent = BaseEvent_3 & {
18485
+ type: 'window-responding';
18486
+ };
18487
+
18488
+ /**
18489
+ * @deprecated Renamed to {@link RestoredEvent}.
18490
+ */
18491
+ declare type WindowRestoredEvent = RestoredEvent;
18492
+
18493
+ /**
18494
+ * @deprecated Renamed to {@link ShownEvent}.
18495
+ */
18496
+ declare type WindowShownEvent = ShownEvent_2;
18497
+
18498
+ /**
18499
+ * @deprecated Renamed to {@link ShowRequestedEvent}.
18500
+ */
18501
+ declare type WindowShowRequestedEvent = ShowRequestedEvent;
18502
+
18503
+ /**
18504
+ * A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
18505
+ * from {@link OpenFin.ViewEvents}.
18506
+ */
18507
+ 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;
18508
+
18509
+ /**
18510
+ * Generated when a child window starts loading.
18511
+ * @interface
18512
+ */
18513
+ declare type WindowStartLoadEvent = BaseEvent_3 & {
18514
+ type: 'window-start-load';
18515
+ };
18516
+
18517
+ /**
18518
+ * Visibility state of a window.
18519
+ */
18520
+ declare type WindowState = 'maximized' | 'minimized' | 'normal';
18521
+
18522
+ /**
18523
+ * A view-related event that fires natively on the `Window` topic. This means that these events *do* propagate
18524
+ * to the `Application` level, with the name pattern `window-view-eventname`.
18525
+ */
18526
+ declare type WindowViewEvent = {
18527
+ viewIdentity: OpenFin.Identity;
18528
+ } & (ViewAttachedEvent | ViewDetachedEvent);
18529
+
18530
+ /**
18531
+ * @interface
18532
+ */
18533
+ declare type WindowViewsPrintOptions = {
18534
+ content: 'views';
18535
+ includeSelf?: boolean;
18536
+ };
18537
+
18538
+ declare type Wire = EventEmitter & {
18539
+ connect(messageReciever: MessageReceiver): Promise<any>;
18540
+ connectSync(): any;
18541
+ send(data: any): Promise<any>;
18542
+ shutdown(): Promise<void>;
18543
+ getPort(): string;
18544
+ };
18545
+
18546
+ declare type WireConstructor = {
18547
+ new (onmessage: (data: any) => void): Wire;
18548
+ };
18549
+
18550
+ /* Excluded from this release type: WithId */
18551
+
18552
+ declare interface WithInterop {
18553
+ interop: InteropClient;
18554
+ }
18555
+
18556
+ /* Excluded from this release type: WithoutId */
18557
+
18558
+ declare type WithPositioningOptions<T extends {} = {}> = T & {
18559
+ positioningOptions?: OpenFin.PositioningOptions;
18560
+ };
18561
+
18562
+ /* Excluded from this release type: WorkspacePlatformOptions */
18563
+
18564
+ /**
18565
+ * A generic request to write any supported data to the clipboard.
18566
+ * @interface
18567
+ */
18568
+ declare type WriteAnyClipboardRequest = BaseClipboardRequest & {
18569
+ /**
18570
+ * Data to be written
18571
+ */
18572
+ data: {
18573
+ text?: string;
18574
+ html?: string;
18575
+ rtf?: string;
18576
+ } & Partial<Pick<WriteImageClipboardRequest, 'image'>>;
18577
+ };
18578
+
18579
+ /**
18580
+ * @deprecated - instead use WriteAnyClipboardRequest
18581
+ *
18582
+ * A generic request to write any supported data to the clipboard.
18583
+ *
18584
+ * @interface
18585
+ */
18586
+ declare type WriteAnyRequestType = WriteAnyClipboardRequest;
18587
+
18588
+ /**
18589
+ * A request to write data to the clipboard.
18590
+ * @interface
18591
+ */
18592
+ declare type WriteClipboardRequest = BaseClipboardRequest & {
18593
+ /**
18594
+ * Data to write to the clipboard.
18595
+ */
18596
+ data: string;
18597
+ };
18598
+
18599
+ /**
18600
+ * @interface
18601
+ */
18602
+ declare type WriteImageClipboardRequest = BaseClipboardRequest & {
18603
+ /**
18604
+ * Can be either a base64 string, or a DataURL string. If using DataURL, the
18605
+ * supported formats are `data:image/png[;base64],` and `data:image/jpeg[;base64],`.
18606
+ * Using other image/<format> DataURLs will throw an Error.
18607
+ */
18608
+ image: string;
18609
+ };
18610
+
18611
+ /**
18612
+ * @deprecated - instead use OpenFin.WriteClipboardRequest
18613
+ *
18614
+ * A request to write data to the clipboard.
18615
+ *
18616
+ * @interface
18617
+ */
18618
+ declare type WriteRequestType = WriteClipboardRequest;
18619
+
18620
+ export { }