@openfin/node-adapter 35.78.15 → 35.78.17

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.
@@ -195,100 +195,6 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
195
195
  */
196
196
  constructor(wire: Transport, identity: OpenFin.ApplicationIdentity);
197
197
  private windowListFromIdentityList;
198
- /**
199
- * Adds a listener to the end of the listeners array for the specified event.
200
- * @param eventType - The type of the event.
201
- * @param listener - Called whenever an event of the specified type occurs.
202
- * @param options - Option to support event timestamps.
203
- *
204
- * @function addListener
205
- * @memberof Application
206
- * @instance
207
- * @tutorial Application.EventEmitter
208
- */
209
- /**
210
- * Adds a listener to the end of the listeners array for the specified event.
211
- * @param eventType - The type of the event.
212
- * @param listener - Called whenever an event of the specified type occurs.
213
- * @param options - Option to support event timestamps.
214
- *
215
- * @function on
216
- * @memberof Application
217
- * @instance
218
- * @tutorial Application.EventEmitter
219
- */
220
- /**
221
- * 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.
222
- * @param eventType - The type of the event.
223
- * @param listener - The callback function.
224
- * @param options - Option to support event timestamps.
225
- *
226
- * @function once
227
- * @memberof Application
228
- * @instance
229
- * @tutorial Application.EventEmitter
230
- */
231
- /**
232
- * Adds a listener to the beginning of the listeners array for the specified event.
233
- * @param eventType - The type of the event.
234
- * @param listener - The callback function.
235
- * @param options - Option to support event timestamps.
236
- *
237
- * @function prependListener
238
- * @memberof Application
239
- * @instance
240
- * @tutorial Application.EventEmitter
241
- */
242
- /**
243
- * 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.
244
- * The listener is added to the beginning of the listeners array.
245
- * @param eventType - The type of the event.
246
- * @param listener - The callback function.
247
- * @param options - Option to support event timestamps.
248
- *
249
- * @function prependOnceListener
250
- * @memberof Application
251
- * @instance
252
- * @tutorial Application.EventEmitter
253
- */
254
- /**
255
- * Remove a listener from the listener array for the specified event.
256
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
257
- * @param eventType - The type of the event.
258
- * @param listener - The callback function.
259
- * @param options - Option to support event timestamps.
260
- *
261
- * @function removeListener
262
- * @memberof Application
263
- * @instance
264
- * @tutorial Application.EventEmitter
265
- */
266
- /**
267
- * Removes all listeners, or those of the specified event.
268
- * @param eventType - The type of the event.
269
- *
270
- * @function removeAllListeners
271
- * @memberof Application
272
- * @instance
273
- * @tutorial Application.EventEmitter
274
- */
275
- /**
276
- * JumpListCategory interface
277
- * @typedef { object } JumpListCategory@typedef { object } JumpListCategory
278
- * @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.
279
- * @property { JumpListItem[] } items Array of JumpListItem objects
280
- */
281
- /**
282
- * @PORTED
283
- * JumpListItem interface
284
- * @typedef { object } JumpListItem@typedef { object } JumpListItem
285
- * @property { string } type One of the following: "task" or "separator". Defaults to task.
286
- * @property { string } title The text to be displayed for the JumpList Item. Should only be set if type is "task".
287
- * @property { string } description Description of the task (displayed in a tooltip). Should only be set if type is "task".
288
- * @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.
289
- * @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).
290
- * @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.
291
- */
292
198
  /**
293
199
  * Determines if the application is currently running.
294
200
  *
@@ -3150,20 +3056,6 @@ declare type ClientInfo = Omit<ClientIdentity, 'isLocalEndpointId'> & {
3150
3056
  connectionUrl: string;
3151
3057
  };
3152
3058
 
3153
- /**
3154
- * @PORTED
3155
- * WriteRequestType interface
3156
- * @typedef { object } WriteRequestType@typedef { object } WriteRequestType
3157
- * @property { string } data Data to be written
3158
- * @property { string } [type] Clipboard Type
3159
- */
3160
- /**
3161
- * @PORTED
3162
- * OpenFin.WriteAnyClipboardRequest interface
3163
- * @typedef { object } OpenFin.WriteAnyClipboardRequest@typedef { object } OpenFin.WriteAnyClipboardRequest
3164
- * @property { string } data Data to be written
3165
- * @property { OpenFin.ClipboardSelectionType } [type] Clipboard Type defaults to 'clipboard', use 'selection' for linux
3166
- */
3167
3059
  /**
3168
3060
  * The Clipboard API allows reading and writing to the clipboard in multiple formats.
3169
3061
  *
@@ -5400,83 +5292,6 @@ declare class ExternalApplication extends EmitterBase<OpenFin.ExternalApplicatio
5400
5292
  * @internal
5401
5293
  */
5402
5294
  constructor(wire: Transport, identity: OpenFin.ApplicationIdentity);
5403
- /**
5404
- * Adds a listener to the end of the listeners array for the specified event.
5405
- * @param eventType - The type of the event.
5406
- * @param listener - Called whenever an event of the specified type occurs.
5407
- * @param options - Option to support event timestamps.
5408
- *
5409
- * @function addListener
5410
- * @memberof ExternalApplication
5411
- * @instance
5412
- * @tutorial ExternalApplication.EventEmitter
5413
- */
5414
- /**
5415
- * Adds a listener to the end of the listeners array for the specified event.
5416
- * @param eventType - The type of the event.
5417
- * @param listener - Called whenever an event of the specified type occurs.
5418
- * @param options - Option to support event timestamps.
5419
- *
5420
- * @function on
5421
- * @memberof ExternalApplication
5422
- * @instance
5423
- * @tutorial ExternalApplication.EventEmitter
5424
- */
5425
- /**
5426
- * 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.
5427
- * @param eventType - The type of the event.
5428
- * @param listener - The callback function.
5429
- * @param options - Option to support event timestamps.
5430
- *
5431
- * @function once
5432
- * @memberof ExternalApplication
5433
- * @instance
5434
- * @tutorial ExternalApplication.EventEmitter
5435
- */
5436
- /**
5437
- * Adds a listener to the beginning of the listeners array for the specified event.
5438
- * @param eventType - The type of the event.
5439
- * @param listener - The callback function.
5440
- * @param options - Option to support event timestamps.
5441
- *
5442
- * @function prependListener
5443
- * @memberof ExternalApplication
5444
- * @instance
5445
- * @tutorial ExternalApplication.EventEmitter
5446
- */
5447
- /**
5448
- * 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.
5449
- * The listener is added to the beginning of the listeners array.
5450
- * @param eventType - The type of the event.
5451
- * @param listener - The callback function.
5452
- * @param options - Option to support event timestamps.
5453
- *
5454
- * @function prependOnceListener
5455
- * @memberof ExternalApplication
5456
- * @instance
5457
- * @tutorial ExternalApplication.EventEmitter
5458
- */
5459
- /**
5460
- * Remove a listener from the listener array for the specified event.
5461
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
5462
- * @param eventType - The type of the event.
5463
- * @param listener - The callback function.
5464
- * @param options - Option to support event timestamps.
5465
- *
5466
- * @function removeListener
5467
- * @memberof ExternalApplication
5468
- * @instance
5469
- * @tutorial ExternalApplication.EventEmitter
5470
- */
5471
- /**
5472
- * Removes all listeners, or those of the specified event.
5473
- * @param eventType - The type of the event.
5474
- *
5475
- * @function removeAllListeners
5476
- * @memberof ExternalApplication
5477
- * @instance
5478
- * @tutorial ExternalApplication.EventEmitter
5479
- */
5480
5295
  /**
5481
5296
  * Retrieves information about the external application.
5482
5297
  *
@@ -5921,83 +5736,6 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
5921
5736
  * @internal
5922
5737
  */
5923
5738
  constructor(wire: Transport, identity: OpenFin.Identity);
5924
- /**
5925
- * Adds the listener function to the end of the listeners array for the specified event type.
5926
- * @param eventType - The type of the event.
5927
- * @param listener - Called whenever an event of the specified type occurs.
5928
- * @param options - Option to support event timestamps.
5929
- *
5930
- * @function addListener
5931
- * @memberof Frame
5932
- * @instance
5933
- * @tutorial Frame.EventEmitter
5934
- */
5935
- /**
5936
- * Adds a listener to the end of the listeners array for the specified event.
5937
- * @param eventType - The type of the event.
5938
- * @param listener - Called whenever an event of the specified type occurs.
5939
- * @param options - Option to support event timestamps.
5940
- *
5941
- * @function on
5942
- * @memberof Frame
5943
- * @instance
5944
- * @tutorial Frame.EventEmitter
5945
- */
5946
- /**
5947
- * 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.
5948
- * @param eventType - The type of the event.
5949
- * @param listener - The callback function.
5950
- * @param options - Option to support event timestamps.
5951
- *
5952
- * @function once
5953
- * @memberof Frame
5954
- * @instance
5955
- * @tutorial Frame.EventEmitter
5956
- */
5957
- /**
5958
- * Adds a listener to the beginning of the listeners array for the specified event.
5959
- * @param eventType - The type of the event.
5960
- * @param listener - The callback function.
5961
- * @param options - Option to support event timestamps.
5962
- *
5963
- * @function prependListener
5964
- * @memberof Frame
5965
- * @instance
5966
- * @tutorial Frame.EventEmitter
5967
- */
5968
- /**
5969
- * 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.
5970
- * The listener is added to the beginning of the listeners array.
5971
- * @param eventType - The type of the event.
5972
- * @param listener - The callback function.
5973
- * @param options - Option to support event timestamps.
5974
- *
5975
- * @function prependOnceListener
5976
- * @memberof Frame
5977
- * @instance
5978
- * @tutorial Frame.EventEmitter
5979
- */
5980
- /**
5981
- * Remove a listener from the listener array for the specified event.
5982
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
5983
- * @param eventType - The type of the event.
5984
- * @param listener - The callback function.
5985
- * @param options - Option to support event timestamps.
5986
- *
5987
- * @function removeListener
5988
- * @memberof Frame
5989
- * @instance
5990
- * @tutorial Frame.EventEmitter
5991
- */
5992
- /**
5993
- * Removes all listeners, or those of the specified event.
5994
- * @param eventType - The type of the event.
5995
- *
5996
- * @function removeAllListeners
5997
- * @memberof Frame
5998
- * @instance
5999
- * @tutorial Frame.EventEmitter
6000
- */
6001
5739
  /**
6002
5740
  * Returns a frame info object for the represented frame.
6003
5741
  *
@@ -7281,56 +7019,6 @@ declare class InteropBroker extends Base {
7281
7019
  static createClosedConstructor(...args: ConstructorParameters<typeof InteropBroker>): {
7282
7020
  new (): InteropBroker;
7283
7021
  };
7284
- /**
7285
- * @REMOVED
7286
- * SetContextOptions interface
7287
- * @typedef { object } SetContextOptions@typedef { object } SetContextOptions
7288
- * @property { Context } {context} - New context to set.
7289
- */
7290
- /**
7291
- * @REMOVED
7292
- * GetContextOptions interface
7293
- * @typedef { object } GetContextOptions@typedef { object } GetContextOptions
7294
- * @property { string } [contextType] - Context Type
7295
- */
7296
- /**
7297
- * @REMOVED
7298
- * JoinContextGroupOptions interface
7299
- * @typedef { object } JoinContextGroupOptions@typedef { object } JoinContextGroupOptions
7300
- * @property { string } contextGroupId - Id of the context group.
7301
- * @property { Identity | ClientIdentity } [target] - Identity of the entity you wish to join to a context group.
7302
- */
7303
- /**
7304
- * @REMOVED
7305
- * AddClientToContextGroupOptions interface
7306
- * @typedef { object } AddClientToContextGroupOptions@typedef { object } AddClientToContextGroupOptions
7307
- * @property { string } contextGroupId - Name of the context group.
7308
- */
7309
- /**
7310
- * @REMOVED
7311
- * RemoveFromContextGroupOptions interface
7312
- * @typedef { object } RemoveFromContextGroupOptions@typedef { object } RemoveFromContextGroupOptions
7313
- * @property { Identity | ClientIdentity } target - Identity of the entity you wish to join to a context group.
7314
- */
7315
- /**
7316
- * @REMOVED
7317
- * GetInfoForContextGroupOptions interface
7318
- * @typedef { object } GetInfoForContextGroupOptions@typedef { object } GetInfoForContextGroupOptions
7319
- * @property { string } contextGroupId - Name of the context group to get info for.
7320
- */
7321
- /**
7322
- * @REMOVED
7323
- * GetAllClientsInContextGroupOptions interface
7324
- * @typedef { object } GetAllClientsInContextGroupOptions@typedef { object } GetAllClientsInContextGroupOptions
7325
- * @property { string } contextGroupId - Name of the context group to get info for.
7326
- */
7327
- /**
7328
- * @PORTED
7329
- * InfoForIntentOptions interface
7330
- * @typedef { object } InfoForIntentOptions@typedef { object } InfoForIntentOptions
7331
- * @property { string } name Name of the intent to get info for.
7332
- * @property { Context } [context] Optional context.
7333
- */
7334
7022
  /**
7335
7023
  * Sets a context for the context group of the incoming current entity.
7336
7024
  * @param setContextOptions - New context to set.
@@ -7830,95 +7518,6 @@ declare type InteropBrokerOptions = {
7830
7518
  logging?: InteropLoggingOptions;
7831
7519
  };
7832
7520
 
7833
- /**
7834
- * @PORTED
7835
- * @typedef { object } Intent
7836
- * @summary The combination of an action and a context that is passed to an application for resolution.
7837
- * @property { string } name Name of the intent.
7838
- * @property { Context } context Data associated with the intent
7839
- */
7840
- /**
7841
- * @REMOVED
7842
- * @typedef { object } Subscription
7843
- * @summary Object returned when subscribing a handler.
7844
- * @property { function } unsubscribe Function to unsubscribe the handler.
7845
- */
7846
- /**
7847
- * @typedef { function } ContextHandler
7848
- * @summary Subscription function for addContextHandler.
7849
- */
7850
- /**
7851
- * @typedef { function } IntentHandler
7852
- * @summary Subscription function for registerIntentHandler
7853
- */
7854
- /**
7855
- * @PORTED
7856
- * @typedef { object } ClientIdentity
7857
- * @summary The Identity for a Channel Client. Includes endpointId to differentiate between different connections for an entity.
7858
- * @property {string} uuid GUID of an application.
7859
- * @property {string} name Name of an entity in an application.
7860
- * @property {string} endpointId Unique differentiator for different Channel connections for an entity.
7861
- */
7862
- /**
7863
- * @PORTED
7864
- * @typedef { object } ContextGroupInfo
7865
- * @summary Information for a Context Group. Contains metadata for displaying the group properly.
7866
- * @property {string} id Name of the context group
7867
- * @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.
7868
- */
7869
- /**
7870
- * @PORTED
7871
- * @typedef { object } DisplayMetadata
7872
- * @summary The display data for a Context Group.
7873
- * @property {string} name A user-readable name for this context group, e.g: `"Red"`
7874
- * @property {string} [color] The color that should be associated within this context group when displaying this context group in a UI, e.g: `0xFF0000`.
7875
- * @property {string} [glyph] A URL of an image that can be used to display this context group
7876
- */
7877
- /**
7878
- * @PORTED
7879
- * @typedef { object } Context
7880
- * @summary Data passed between entities and applications.
7881
- * @property {object} [id] An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
7882
- * @property {string} [name] User-readable name for the incoming context.
7883
- * @property {string} type Conserved type for the context (e.g. `instrument` or `country`)
7884
- */
7885
- /**
7886
- * @REMOVED
7887
- * @typedef { object } ContextForIntent
7888
- * @summary Data passed between entities and applications, including an optional metadata.
7889
- * @property {object} [id] An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
7890
- * @property {string} [name] User-readable name for the incoming context.
7891
- * @property {string} type Conserved type for the context (e.g. `instrument` or `country`)
7892
- * @property {any} [metadata]
7893
- */
7894
- /**
7895
- * @REMOVED
7896
- * @typedef { object } SessionContextGroup
7897
- * @summary An instance of a SessionContextGroup
7898
- * @property {string} id The SessionContextGroup's id.
7899
- * @property {setContext} setContext Sets a context of a certain type
7900
- * @property {getCurrentContext} getCurrentContext Gets the currently set context of a certain type
7901
- * @property {addContextHandler} addContextHandler Adds a handler for context change.
7902
- */
7903
- /**
7904
- * @typedef {function} setContext
7905
- * @summary A SessionContextGroup instance method for setting a context in the SessionContextGroup.
7906
- * @param context The Context to be set.
7907
- *
7908
- */
7909
- /**
7910
- * @typedef {function} getCurrentContext
7911
- * @summary A SessionContextGroup instance method for getting the current context of a certain type.
7912
- * @param contextType The Context Type to get. If not specified the last contextType set would get used.
7913
- *
7914
- */
7915
- /**
7916
- * @typedef {function} addContextHandler
7917
- * @summary A SessionContextGroup instance method for adding a handler for context change.
7918
- * @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.
7919
- * @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.
7920
- *
7921
- */
7922
7521
  /**
7923
7522
  * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}
7924
7523
  *
@@ -8357,13 +7956,6 @@ declare type InteropLoggingActions = 'beforeAction' | 'afterAction';
8357
7956
  */
8358
7957
  declare type InteropLoggingOptions = Record<InteropLoggingActions, InteropActionLoggingOption>;
8359
7958
 
8360
- /**
8361
- * @PORTED
8362
- * @typedef { object } InteropConfig
8363
- * @summary Information relevant to the Interop Broker.
8364
- * @property {string} [currentContextGroup] Context Group for the client. (green, yellow, red, etc.)
8365
- * @property {string} [providerId] When provided, automatically connects the client to the specified provider uuid
8366
- */
8367
7959
  /**
8368
7960
  * Manages creation of Interop Brokers and Interop Clients. These APIs are called under-the-hood in Platforms.
8369
7961
  *
@@ -14102,83 +13694,6 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
14102
13694
  */
14103
13695
  constructor(wire: Transport);
14104
13696
  private sendExternalProcessRequest;
14105
- /**
14106
- * Adds a listener to the end of the listeners array for the specified event.
14107
- * @param eventType - The type of the event.
14108
- * @param listener - Called whenever an event of the specified type occurs.
14109
- * @param options - Option to support event timestamps.
14110
- *
14111
- * @function addListener
14112
- * @memberof System
14113
- * @instance
14114
- * @tutorial System.EventEmitter
14115
- */
14116
- /**
14117
- * Adds a listener to the end of the listeners array for the specified event.
14118
- * @param eventType - The type of the event.
14119
- * @param listener - Called whenever an event of the specified type occurs.
14120
- * @param options - Option to support event timestamps.
14121
- *
14122
- * @function on
14123
- * @memberof System
14124
- * @instance
14125
- * @tutorial System.EventEmitter
14126
- */
14127
- /**
14128
- * 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.
14129
- * @param eventType - The type of the event.
14130
- * @param listener - The callback function.
14131
- * @param options - Option to support event timestamps.
14132
- *
14133
- * @function once
14134
- * @memberof System
14135
- * @instance
14136
- * @tutorial System.EventEmitter
14137
- */
14138
- /**
14139
- * Adds a listener to the beginning of the listeners array for the specified event.
14140
- * @param eventType - The type of the event.
14141
- * @param listener - The callback function.
14142
- * @param options - Option to support event timestamps.
14143
- *
14144
- * @function prependListener
14145
- * @memberof System
14146
- * @instance
14147
- * @tutorial System.EventEmitter
14148
- */
14149
- /**
14150
- * 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.
14151
- * The listener is added to the beginning of the listeners array.
14152
- * @param eventType - The type of the event.
14153
- * @param listener - The callback function.
14154
- * @param options - Option to support event timestamps.
14155
- *
14156
- * @function prependOnceListener
14157
- * @memberof System
14158
- * @instance
14159
- * @tutorial System.EventEmitter
14160
- */
14161
- /**
14162
- * Remove a listener from the listener array for the specified event.
14163
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
14164
- * @param eventType - The type of the event.
14165
- * @param listener - The callback function.
14166
- * @param options - Option to support event timestamps.
14167
- *
14168
- * @function removeListener
14169
- * @memberof System
14170
- * @instance
14171
- * @tutorial System.EventEmitter
14172
- */
14173
- /**
14174
- * Removes all listeners, or those of the specified event.
14175
- * @param eventType - The type of the event.
14176
- *
14177
- * @function removeAllListeners
14178
- * @memberof System
14179
- * @instance
14180
- * @tutorial System.EventEmitter
14181
- */
14182
13697
  /**
14183
13698
  * Returns the version of the runtime. The version contains the major, minor,
14184
13699
  * build and revision numbers.
@@ -16213,169 +15728,6 @@ declare type VerboseWebPermission = {
16213
15728
 
16214
15729
  declare type View = OpenFin.View;
16215
15730
 
16216
- /**
16217
- * @PORTED
16218
- * @typedef {object} View~options
16219
- * @summary View creation options.
16220
- * @desc This is the options object required by {@link View.create View.create}.
16221
- *
16222
- * Note that `name` and `target` are the only required properties — albeit the `url` property is usually provided as well
16223
- * (defaults to `"about:blank"` when omitted).
16224
- *
16225
- * @property {object} [experimental]
16226
- * Configurations for API injection.
16227
- *
16228
- * @property {boolean} [experimental.childWindows] Configure if the runtime should enable child windows for views.
16229
- *
16230
- * @property {object} [accelerator]
16231
- * Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
16232
- *
16233
- * @property {boolean} [accelerator.devtools=false]
16234
- * If `true`, enables the devtools keyboard shortcut:<br>
16235
- * `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
16236
- *
16237
- * @property {boolean} [accelerator.reload=false]
16238
- * If `true`, enables the reload keyboard shortcuts:<br>
16239
- * `Ctrl` + `R` _(Windows)_<br>
16240
- * `F5` _(Windows)_<br>
16241
- * `Command` + `R` _(Mac)_
16242
- *
16243
- * @property {boolean} [accelerator.reloadIgnoringCache=false]
16244
- * If `true`, enables the reload-from-source keyboard shortcuts:<br>
16245
- * `Ctrl` + `Shift` + `R` _(Windows)_<br>
16246
- * `Shift` + `F5` _(Windows)_<br>
16247
- * `Command` + `Shift` + `R` _(Mac)_
16248
- *
16249
- * @property {boolean} [accelerator.zoom=false]
16250
- * If `true`, enables the zoom keyboard shortcuts:<br>
16251
- * `Ctrl` + `+` _(Zoom In)_<br>
16252
- * `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
16253
- * `Ctrl` + `NumPad+` _(Zoom In)_<br>
16254
- * `Ctrl` + `-` _(Zoom Out)_<br>
16255
- * `Ctrl` + `Shift` + `-` _(Zoom Out)_<br>
16256
- * `Ctrl` + `NumPad-` _(Zoom Out)_<br>
16257
- * `Ctrl` + `Scroll` _(Zoom In & Out)_<br>
16258
- * `Ctrl` + `0` _(Restore to 100%)_
16259
- *
16260
- * @property {object} [api]
16261
- * Configurations for API injection.
16262
- *
16263
- * @property {object} [api.iframe] Configure if the the API should be injected into iframes based on domain.
16264
- *
16265
- * @property {boolean} [api.iframe.crossOriginInjection=false] Controls if the `fin` API object is present for cross origin iframes.
16266
- * @property {boolean} [api.iframe.sameOriginInjection=true] Controls if the `fin` API object is present for same origin iframes.
16267
- *
16268
- * @property {string} [autoplayPolicy="no-user-gesture-required"]
16269
- * Autoplay policy to apply to content in the window, can be
16270
- * `no-user-gesture-required`, `user-gesture-required`,
16271
- * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
16272
- *
16273
- * @property {object} [autoResize] AutoResize options
16274
- *
16275
- * @property {object} [bounds] initial bounds given relative to the window.
16276
- *
16277
- * @property {string} [backgroundColor="#FFF"] - _Updatable._
16278
- * The view’s _backfill_ color as a hexadecimal value. Not to be confused with the content background color
16279
- * (`document.body.style.backgroundColor`),
16280
- * this color briefly fills a view’s (a) content area before its content is loaded as well as (b) newly exposed
16281
- * areas when growing a window. Setting
16282
- * this value to the anticipated content background color can help improve user experience.
16283
- * Default is white.
16284
- *
16285
- * @property {object} [contentNavigation]
16286
- * Restrict navigation to URLs that match an allowed pattern.
16287
- * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
16288
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
16289
- * @property {string[]} [contentNavigation.allowlist=[]] List of allowed URLs.
16290
- * @property {string[]} [contentNavigation.denylist=[]] List of denied URLs.
16291
- *
16292
- * @property {object} [contentRedirect]
16293
- * Restrict redirects to URLs that match an allowed pattern.
16294
- * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
16295
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
16296
- * @property {string[]} [contentRedirect.allowlist=[]] List of allowed URLs.
16297
- * @property {string[]} [contentRedirect.denylist=[]] List of denied URLs.
16298
- *
16299
- * @property {object} [contextMenuSettings] - _Updatable._
16300
- * Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
16301
- * Configure the context menu when right-clicking on a view.
16302
- * @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
16303
- * @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
16304
- * @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
16305
- *
16306
- * @property {object} [contextMenuOptions] - _Updatable._
16307
- * Configure the context menu when right-clicking on a view. Supported menu items:
16308
- * 'separator'
16309
- * 'cut'
16310
- * 'copy'
16311
- * 'copyImage',
16312
- * 'paste'
16313
- * 'spellCheck'
16314
- * 'inspect'
16315
- * 'reload'
16316
- * 'navigateForward'
16317
- * 'navigateBack'
16318
- * 'print'
16319
- * @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
16320
- * @property {string[]} [contextMenuOptions.template=[]] List of context menu items to display on right-click.
16321
- *
16322
- * @property {any} [customData=""] - _Updatable._
16323
- * A field that the user can attach serializable data to be ferried around with the view options.
16324
- * _When omitted, the default value of this property is the empty string (`""`)._
16325
- *
16326
- * @property {any} [customContext=""] - _Updatable._
16327
- * A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
16328
- * is called.
16329
- * When omitted, the default value of this property is the empty string (`""`).
16330
- * As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
16331
- *
16332
- * @property {object[]} [hotkeys=[]] - _Updatable._
16333
- * Defines the list of hotkeys that will be emitted as a `hotkey` event on the view. For usage example see [example]{@tutorial hotkeys}.
16334
- * Within Platform, OpenFin also implements a set of pre-defined actions called
16335
- * [keyboard commands]{@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands}
16336
- * that can be assigned to a specific hotkey in the platform manifest.
16337
- * @property {string} hotkeys.keys The key combination of the hotkey, i.e. "Ctrl+T"
16338
- * @property {boolean} [hotkeys.preventDefault=false] preventDefault will prevent the page keydown/keyup events from being emitted.
16339
- *
16340
- * @property {boolean} [isClosable=true] **Platforms Only.** If false, the view will be persistent and can't be closed through
16341
- * either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
16342
- * if the view isn't part of the new layout when running `Layout.replace`.
16343
- *
16344
- * @property {string} name
16345
- * The name of the view.
16346
- *
16347
- * @property {boolean} [detachOnClose=false] - _Updatable._
16348
- * Platforms Only. If true, will hide and detach the View from the window for later use instead of closing,
16349
- * allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
16350
- *
16351
- * @property {string} [manifestUrl] **Platforms Only.** Url to a manifest that contains View Options. Properties other than manifestUrl can still be used
16352
- * but the properties in the manifest will take precedence if there is any collision.
16353
- *
16354
- * @property {preloadScript[]} [preloadScripts] - _Inheritable_
16355
- * A list of scripts that are eval'ed before other scripts in the page. When omitted, _inherits_
16356
- * from the parent application.
16357
- *
16358
- * @property {boolean} [preventDragOut=false] **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
16359
- *
16360
- * @property {string} [processAffinity=<application uuid>]
16361
- * A string to attempt to group renderers together. Will only be used if pages are on the same origin.
16362
- *
16363
- * @property {boolean} [spellCheck=false]
16364
- * Enable spell check in input text fields for the view.
16365
- *
16366
- * @property {Identity} [target]
16367
- * The identity of the window this view should be attached to.
16368
- *
16369
- * @property {string} [url="about:blank"]
16370
- * The URL of the view.
16371
- *
16372
- * @property {string} [uuid=<application uuid>]
16373
- * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
16374
- * If omitted, defaults to the `uuid` of the application spawning the view.
16375
- * If given, must match the `uuid` of the application spawning the view.
16376
- * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
16377
- * really no need to provide it.
16378
- */
16379
15731
  /**
16380
15732
  * A View can be used to embed additional web content into a Window.
16381
15733
  * It is like a child window, except it is positioned relative to its owning window.
@@ -18205,476 +17557,6 @@ declare type WillResizeEvent = WillMoveOrResizeEvent & {
18205
17557
  type: 'will-resize';
18206
17558
  };
18207
17559
 
18208
- /**
18209
- * @PORTED
18210
- * @typedef { object } Margins@typedef { object } Margins
18211
- * @property { string } [marginType]
18212
- * Can be `default`, `none`, `printableArea`, or `custom`. If `custom` is chosen,
18213
- * you will also need to specify `top`, `bottom`, `left`, and `right`.
18214
- *
18215
- * @property { number } [top] The top margin of the printed web page, in pixels.
18216
- * @property { number } [bottom] The bottom margin of the printed web page, in pixels.
18217
- * @property { number } [left] The left margin of the printed web page, in pixels.
18218
- * @property { number } [right] The right margin of the printed web page, in pixels.
18219
- */
18220
- /**
18221
- * @PORTED
18222
- * @typedef { object } Dpi@typedef { object } Dpi
18223
- * @property { number } [horizontal] The horizontal dpi
18224
- * @property { number } [vertical] The vertical dpi
18225
- */
18226
- /**
18227
- * @PORTED
18228
- * @typedef { object } PrintOptions@typedef { object } PrintOptions
18229
- * @property { boolean } [silent=false] Don't ask user for print settings.
18230
- * @property { boolean } [printBackground=false] Prints the background color and image of the web page.
18231
- * @property { string } [deviceName=''] Set the printer device name to use.
18232
- * @property { boolean } [color=true] Set whether the printed web page will be in color or grayscale.
18233
- * @property { Margins } [margins] Set margins for the printed web page
18234
- * @property { boolean } [landscape=false] Whether the web page should be printed in landscape mode.
18235
- * @property { number } [scaleFactor] The scale factor of the web page.
18236
- * @property { number } [pagesPerSheet] The number of pages to print per page sheet.
18237
- * @property { boolean } [collate] Whether the web page should be collated.
18238
- * @property { number } [copies] The number of copies of the web page to print.
18239
- * @property { Record<string, number> } [pageRanges] The page range to print. Should have two keys: from and to.
18240
- * @property { string } [duplexMode] Set the duplex mode of the printed web page. Can be simplex, shortEdge, or longEdge.
18241
- * @property { Dpi } [dpi] Set dpi for the printed web page
18242
- */
18243
- /**
18244
- * @REMOVED
18245
- * PrinterInfo interface
18246
- * @typedef { object } PrinterInfo@typedef { object } PrinterInfo
18247
- * @property { string } name Printer Name
18248
- * @property { string } description Printer Description
18249
- * @property { number } status Printer Status
18250
- * @property { boolean } isDefault Indicates that system's default printer
18251
- */
18252
- /**
18253
- * @REMOVED
18254
- * SharedWorkerInfo interface
18255
- * @typedef { object } SharedWorkerInfo@typedef { object } SharedWorkerInfo
18256
- * @property { string } id The unique id of the shared worker.
18257
- * @property { string } url The url of the shared worker.
18258
- */
18259
- /**
18260
- * @PORTED
18261
- * ContentCreationRule interface
18262
- * @typedef { object } ContentCreationRule@typedef { object } ContentCreationRule
18263
- * @property { string } behavior 'view' | 'window' | 'browser' | 'block'
18264
- * @property { string[] } match List of [match patterns](https://developer.chrome.com/extensions/match_patterns).
18265
- * @property { object } options Window creation options or View creation options.
18266
- */
18267
- /**
18268
- * @PORTED
18269
- * @typedef {object} Window~options
18270
- * @summary Window creation options.
18271
- * @desc This is the options object required by {@link Window.create Window.create}.
18272
- *
18273
- * Note that `name` is the only required property — albeit the `url` property is usually provided as well
18274
- * (defaults to `"about:blank"` when omitted).
18275
- *
18276
- * _This jsdoc typedef mirrors the `WindowOptions` TypeScript interface in `@types/openfin`._
18277
- *
18278
- * @property {object} [accelerator]
18279
- * Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
18280
- *
18281
- * @property {boolean} [accelerator.devtools=false]
18282
- * If `true`, enables the devtools keyboard shortcut:<br>
18283
- * `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
18284
- *
18285
- * @property {boolean} [accelerator.reload=false]
18286
- * If `true`, enables the reload keyboard shortcuts:<br>
18287
- * `Ctrl` + `R` _(Windows)_<br>
18288
- * `F5` _(Windows)_<br>
18289
- * `Command` + `R` _(Mac)_
18290
- *
18291
- * @property {boolean} [accelerator.reloadIgnoringCache=false]
18292
- * If `true`, enables the reload-from-source keyboard shortcuts:<br>
18293
- * `Ctrl` + `Shift` + `R` _(Windows)_<br>
18294
- * `Shift` + `F5` _(Windows)_<br>
18295
- * `Command` + `Shift` + `R` _(Mac)_
18296
- *
18297
- * @property {boolean} [accelerator.zoom=false]
18298
- * 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.
18299
- * If `true`, enables the zoom keyboard shortcuts:<br>
18300
- * `Ctrl` + `+` _(Zoom In)_<br>
18301
- * `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
18302
- * `Ctrl` + `NumPad+` _(Zoom In)_<br>
18303
- * `Ctrl` + `-` _(Zoom Out)_<br>
18304
- * `Ctrl` + `Shift` + `-` _(Zoom Out)_<br>
18305
- * `Ctrl` + `NumPad-` _(Zoom Out)_<br>
18306
- * `Ctrl` + `Scroll` _(Zoom In & Out)_<br>
18307
- * `Ctrl` + `0` _(Restore to 100%)_
18308
- *
18309
- * @property {object} [alphaMask] - _Experimental._ _Updatable._
18310
- * <br>
18311
- * alphaMask turns anything of matching RGB value transparent.
18312
- * <br>
18313
- * Caveats:
18314
- * * Runtime flags --disable-gpu and --allow-unsafe-compositing are required. Note: Unclear behavior on remote Desktop support
18315
- * * User cannot click-through transparent regions
18316
- * * Not supported on Mac
18317
- * * Windows Aero must be enabled
18318
- * * Won't make visual sense on Pixel-pushed environments such as Citrix
18319
- * * Not supported on rounded corner windows
18320
- * @property {number} [alphaMask.red=-1] 0-255
18321
- * @property {number} [alphaMask.green=-1] 0-255
18322
- * @property {number} [alphaMask.blue=-1] 0-255
18323
- *
18324
- * @property {boolean} [alwaysOnTop=false] - _Updatable._
18325
- * A flag to always position the window at the top of the window stack.
18326
- *
18327
- * @property {object} [api]
18328
- * Configurations for API injection.
18329
- *
18330
- * @property {object} [api.iframe] Configure if the the API should be injected into iframes based on domain.
18331
- *
18332
- * @property {boolean} [api.iframe.crossOriginInjection=false] Controls if the `fin` API object is present for cross origin iframes.
18333
- * @property {boolean} [api.iframe.sameOriginInjection=true] Controls if the `fin` API object is present for same origin iframes.
18334
- *
18335
- * @property {string} [applicationIcon = ""] - _Deprecated_ - use `icon` instead.
18336
- *
18337
- * @property {number} [aspectRatio=0] - _Updatable._
18338
- * The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
18339
- * an aspect ratio will not be enforced.
18340
- *
18341
- * @property {string} [autoplayPolicy="no-user-gesture-required"]
18342
- * Autoplay policy to apply to content in the window, can be
18343
- * `no-user-gesture-required`, `user-gesture-required`,
18344
- * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
18345
- *
18346
- * @property {boolean} [autoShow=true]
18347
- * A flag to automatically show the window when it is created.
18348
- *
18349
- * @property {string} [backgroundColor="#FFF"]
18350
- * The window’s _backfill_ color as a hexadecimal value. Not to be confused with the content background color
18351
- * (`document.body.style.backgroundColor`),
18352
- * this color briefly fills a window’s (a) content area before its content is loaded as well as (b) newly exposed
18353
- * areas when growing a window. Setting
18354
- * this value to the anticipated content background color can help improve user experience.
18355
- * Default is white.
18356
- *
18357
- * @property {object} [contentCreation]
18358
- * Apply rules that determine how user interaction (`window.open` and links) creates content.
18359
- * @property {ContentCreationRule[]} [contentCreation.rules = []] List of content creation rules.
18360
- *
18361
- * @property {object} [contentNavigation]
18362
- * Restrict navigation to URLs that match an allowed pattern.
18363
- * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
18364
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
18365
- * @property {string[]} [contentNavigation.allowlist=[]] List of allowed URLs.
18366
- * @property {string[]} [contentNavigation.denylist=[]] List of denied URLs.
18367
- *
18368
- * @property {object} [contentRedirect]
18369
- * Restrict redirects to URLs that match an allowed pattern.
18370
- * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
18371
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
18372
- * @property {string[]} [contentRedirect.allowlist=[]] List of allowed URLs.
18373
- * @property {string[]} [contentRedirect.denylist=[]] List of denied URLs.
18374
- *
18375
- * @property {boolean} [contextMenu=true] - _Updatable._
18376
- * A flag to show the context menu when right-clicking on a window.
18377
- * Gives access to the devtools for the window.
18378
- *
18379
- * @property {object} [contextMenuSettings] - _Updatable._
18380
- * Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
18381
- * Configure the context menu when right-clicking on a window.
18382
- * @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
18383
- * @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
18384
- * @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
18385
- *
18386
- * @property {object} [contextMenuOptions] - _Updatable._
18387
- * Configure the context menu when right-clicking on a window. Supported menu items:
18388
- * 'separator'
18389
- * 'cut'
18390
- * 'copy'
18391
- * 'paste'
18392
- * 'spellCheck'
18393
- * 'inspect'
18394
- * 'reload'
18395
- * 'navigateForward'
18396
- * 'navigateBack'
18397
- * 'print'
18398
- * @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
18399
- * @property {string[]} [contextMenuSettings.template=[]] List of context menu items to display on right-click.
18400
- *
18401
- * @property {object} [cornerRounding] - _Updatable._
18402
- * Defines and applies rounded corners for a frameless window. **NOTE:** On macOS corner is not ellipse but circle rounded by the
18403
- * average of _height_ and _width_.
18404
- * @property {number} [cornerRounding.height=0] The height in pixels.
18405
- * @property {number} [cornerRounding.width=0] The width in pixels.
18406
- *
18407
- * @property {any} [customContext=""] - _Updatable. Inheritable._
18408
- * A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
18409
- * is called. If a window in a Platform is trying to update or retrieve its own context, it can use the
18410
- * {@link Platform#setWindowContext Platform.setWindowContext} and {@link Platform#getWindowContext Platform.getWindowContext} calls.
18411
- * _When omitted, _inherits_ from the parent application._
18412
- * As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
18413
- *
18414
- * @property {any} [customData=""] - _Updatable. Inheritable._
18415
- * A field that the user can attach serializable data to be ferried around with the window options.
18416
- * _When omitted, _inherits_ from the parent application._
18417
- *
18418
- * @property {object[]} [customRequestHeaders]
18419
- * Defines list of custom headers for requests sent by the window.
18420
- * @property {string[]} [customRequestHeaders.urlPatterns=[]] The URL patterns for which the headers will be applied
18421
- * @property {object[]} [customRequestHeaders.headers=[]] Objects representing headers and their values,
18422
- * where the object key is the name of header and value at key is the value of the header
18423
- *
18424
- * @property {boolean} [closeOnLastViewRemoved=true] - _Experimental._ _Updatable._
18425
- * Toggling off would keep the Window alive even if all its Views were closed.
18426
- * This is meant for advanced users and should be used with caution.
18427
- * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
18428
- * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
18429
- * ** note ** - This option is ignored in non-Platforms apps.
18430
- *
18431
- * @property {boolean} [defaultCentered=false]
18432
- * Centers the window in the primary monitor. This option overrides `defaultLeft` and `defaultTop`. When `saveWindowState` is `true`,
18433
- * this value will be ignored for subsequent launches in favor of the cached value. **NOTE:** On macOS _defaultCenter_ is
18434
- * somewhat above center vertically.
18435
- *
18436
- * @property {number} [defaultHeight=500]
18437
- * The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
18438
- * in favor of the cached value.
18439
- *
18440
- * @property {number} [defaultLeft=100]
18441
- * The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
18442
- * launches in favor of the cached value.
18443
- *
18444
- * @property {number} [defaultTop=100]
18445
- * The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
18446
- * launches in favor of the cached value.
18447
- *
18448
- * @property {number} [defaultWidth=800]
18449
- * The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
18450
- * launches in favor of the cached value.
18451
- *
18452
- * @property {boolean} [includeInSnapshots=true] - _Updatable._
18453
- * When true, the window will be be included in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
18454
- * inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
18455
- *
18456
- * @property {boolean} [frame=true] - _Updatable._
18457
- * A flag to show the frame.
18458
- *
18459
- * @hidden-property {boolean} [hideOnClose=false] - A flag to allow a window to be hidden when the close button is clicked.
18460
- *
18461
- * @property {object[]} [hotkeys=[]] - _Updatable._
18462
- * Defines the list of hotkeys that will be emitted as a `hotkey` event on the window. For usage example see [example]{@tutorial hotkeys}.
18463
- * Within Platform, OpenFin also implements a set of pre-defined actions called
18464
- * [keyboard commands]{@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands}
18465
- * that can be assigned to a specific hotkey in the platform manifest.
18466
- * @property {string} hotkeys.keys The key combination of the hotkey, i.e. "Ctrl+T"
18467
- * @property {boolean} [hotkeys.preventDefault=false] Whether or not to prevent default key handling before emitting the event
18468
- *
18469
- * @property {string} [icon] - _Updatable. Inheritable._
18470
- * A URL for the icon to be shown in the window title bar and the taskbar.
18471
- * When omitted, inherits from the parent application._
18472
- * note: Window OS caches taskbar icons, therefore an icon change might only be visible after the cache is removed or the uuid is changed.
18473
- *
18474
- * @property {number} [maxHeight=-1] - _Updatable._
18475
- * The maximum height of a window. Will default to the OS defined value if set to -1.
18476
- *
18477
- * @property {boolean} [maximizable=true] - _Updatable._
18478
- * A flag that lets the window be maximized.
18479
- *
18480
- * @property {number} [maxWidth=-1] - _Updatable._
18481
- * The maximum width of a window. Will default to the OS defined value if set to -1.
18482
- *
18483
- * @property {number} [minHeight=0] - _Updatable._
18484
- * The minimum height of a window.
18485
- *
18486
- * @property {boolean} [minimizable=true] - _Updatable._
18487
- * A flag that lets the window be minimized.
18488
- *
18489
- * @property {number} [minWidth=0] - _Updatable._
18490
- * The minimum width of a window.
18491
- *
18492
- * @property {Identity} [modalParentIdentity]
18493
- * Parent identity of a modal window. It will create a modal child window when this option is set.
18494
- *
18495
- * @property {string} name
18496
- * The name of the window.
18497
- *
18498
- * @property {number} [opacity=1.0] - _Updatable._
18499
- * A flag that specifies how transparent the window will be.
18500
- * Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
18501
- * This value is clamped between `0.0` and `1.0`.
18502
- * * In software composition mode, the runtime flag --allow-unsafe-compositing is required.
18503
- *
18504
- * @property {preloadScript[]} [preloadScripts] - _Inheritable_
18505
- * A list of scripts that are eval'ed before other scripts in the page. When omitted, _inherits_
18506
- * from the parent application.
18507
- *
18508
- * @property {string} [processAffinity]
18509
- * A string to attempt to group renderers together. Will only be used if pages are on the same origin.
18510
- *
18511
- * @property {boolean} [resizable=true] - _Updatable._
18512
- * A flag to allow the user to resize the window.
18513
- *
18514
- * @property {object} [resizeRegion] - _Updatable._
18515
- * Defines a region in pixels that will respond to user mouse interaction for resizing a frameless window.
18516
- * @property {number} [resizeRegion.bottomRightCorner=9]
18517
- * The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
18518
- * @property {number} [resizeRegion.size=7]
18519
- * The size in pixels.
18520
- * @property {object} [resizeRegion.sides={top:true,right:true,bottom:true,left:true}]
18521
- * Sides that a window can be resized from.
18522
- *
18523
- * @property {boolean} [saveWindowState=true]
18524
- * A flag to cache the location of the window.
18525
- * ** note ** - This option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
18526
- *
18527
- * @property {boolean} [ignoreSavedWindowState]
18528
- * A flag to ignore previously cached state of the window. It defaults the opposite value of `saveWindowState` to maintain backwards compatibility.
18529
- *
18530
- * @property {boolean} [shadow=false]
18531
- * A flag to display a shadow on frameless windows.
18532
- * `shadow` and `cornerRounding` are mutually exclusive.
18533
- * On Windows 7, Aero theme is required.
18534
- *
18535
- * @property {boolean} [showBackgroundImages=false] - _Updatable._
18536
- * Platforms Only. If true, will show background images in the layout when the Views are hidden.
18537
- * This occurs when the window is resizing or a tab is being dragged within the layout.
18538
- *
18539
- * @property {boolean} [showTaskbarIcon=true] - _Updatable._ _Windows_.
18540
- * A flag to show the window's icon in the taskbar.
18541
- *
18542
- * @property {boolean} [smallWindow=false]
18543
- * A flag to specify a frameless window that can be be created and resized to less than 41x36 px (width x height).
18544
- * _Note: Caveats of small windows are no Aero Snap and drag to/from maximize._
18545
- * _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
18546
- *
18547
- * @property {boolean} [spellCheck=false]
18548
- * Enable spell check in input text fields for the window.
18549
- *
18550
- * @property {string} [state="normal"]
18551
- * The visible state of the window on creation.
18552
- * One of:
18553
- * * `"maximized"`
18554
- * * `"minimized"`
18555
- * * `"normal"`
18556
- *
18557
- * @property {string} [taskbarIcon=string] - Deprecated - use `icon` instead._Windows_.
18558
- *
18559
- * @property {string} [taskbarIconGroup=<application uuid>] - _Windows_.
18560
- * Specify a taskbar group for the window.
18561
- * _If omitted, defaults to app's uuid (`fin.Application.getCurrentSync().identity.uuid`)._
18562
- *
18563
- * @property {string} [url="about:blank"]
18564
- * The URL of the window.
18565
- *
18566
- * @property {string} [uuid=<application uuid>]
18567
- * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
18568
- * If omitted, defaults to the `uuid` of the application spawning the window.
18569
- * If given, must match the `uuid` of the application spawning the window.
18570
- * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
18571
- * really no need to provide it.
18572
- *
18573
- * @property {boolean} [waitForPageLoad=false]
18574
- * When set to `true`, the window will not appear until the `window` object's `load` event fires.
18575
- * When set to `false`, the window will appear immediately without waiting for content to be loaded.
18576
- *
18577
- * @property {ViewVisibility} [viewVisibility]
18578
- * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
18579
- */
18580
- /**
18581
- * @PORTED
18582
- * @typedef {Object} ViewVisibility@typedef {Object} ViewVisibility _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
18583
- * @property {ShowViewsOnWindowResize} [showViewsOnWindowResize] Enables views to be shown when a Platform Window is being resized by the user.
18584
- * @property {ShowViewsOnSplitterDrag} [showViewsOnSplitterDrag] Allows views to be shown when they are resized by the user dragging the splitter between layout stacks.
18585
- * @property {ShowViewsOnTabDrag} [showViewsOnTabDrag] _Supported on Windows Operating Systems only_. Allows views to be shown when the user is dragging a tab around a layout.
18586
- */
18587
- /**
18588
- * @PORTED
18589
- * @typedef {Object} ShowViewsOnWindowResize@typedef {Object} ShowViewsOnWindowResize _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
18590
- * @property {boolean} [enabled=false] Enables or disables showing Views when a Platform Window is being resized.
18591
- * @property {number} [paintIntervalMs=0] Number of miliseconds to wait between view repaints.
18592
- */
18593
- /**
18594
- * @REMOVED
18595
- * @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.
18596
- * @property {boolean} [enabled=false] Enables or disables showing views when the layout splitter is being dragged.
18597
- */
18598
- /**
18599
- * @REMOVED
18600
- * @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.
18601
- * @property {boolean} [enabled=false] Enables or disables showing views when a tab is being dragged.
18602
- */
18603
- /**
18604
- * @PORTED
18605
- * @typedef {object} CapturePageOptions@typedef {object} CapturePageOptions
18606
- * @property { Area } [area] The area of the window to be captured.
18607
- * @property { string } [format='png'] The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
18608
- * @property { number } [quality=100] Number representing quality of JPEG image only. Between 0 - 100.
18609
- */
18610
- /**
18611
- * @PORTED
18612
- * @typedef { object } Area@typedef { object } Area
18613
- * @property { number } height Area's height
18614
- * @property { number } width Area's width
18615
- * @property { number } x X coordinate of area's starting point
18616
- * @property { number } y Y coordinate of area's starting point
18617
- */
18618
- /**
18619
- * @PORTED
18620
- * @typedef {object} FindInPageOptions@typedef {object} FindInPageOptions
18621
- * @property {boolean} [forward=true] Whether to search forward or backward.
18622
- * @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.
18623
- * @property {boolean} [matchCase=false] Whether search should be case-sensitive.
18624
- * @property {boolean} [wordStart=false] Whether to look only at the start of words.
18625
- * @property {boolean} [medialCapitalAsWordStart=false]
18626
- * 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>
18627
- * lowercase or non-letter. Accepts several other intra-word matches.
18628
- */
18629
- /**
18630
- * @REMOVED
18631
- * @typedef {object} Transition@typedef {object} Transition
18632
- * @property {Opacity} opacity - The Opacity transition
18633
- * @property {Position} position - The Position transition
18634
- * @property {Size} size - The Size transition
18635
- */
18636
- /**
18637
- * @PORTED
18638
- * @typedef {object} TransitionOptions@typedef {object} TransitionOptions
18639
- * @property {boolean} interrupt - This option interrupts the current animation. When false it pushes
18640
- this animation onto the end of the animation queue.
18641
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
18642
- */
18643
- /**
18644
- * @PORTED
18645
- * @typedef {object} Size@typedef {object} Size
18646
- * @property {number} duration - The total time in milliseconds this transition should take.
18647
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
18648
- * @property {number} width - Optional if height is present. Defaults to the window's current width.
18649
- * @property {number} height - Optional if width is present. Defaults to the window's current height.
18650
- */
18651
- /**
18652
- * @PORTED
18653
- * @typedef {object} Position@typedef {object} Position
18654
- * @property {number} duration - The total time in milliseconds this transition should take.
18655
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
18656
- * @property {number} left - Defaults to the window's current left position in virtual screen coordinates.
18657
- * @property {number} top - Defaults to the window's current top position in virtual screen coordinates.
18658
- */
18659
- /**
18660
- * @PORTED
18661
- * @typedef {object} Opacity@typedef {object} Opacity
18662
- * @property {number} duration - The total time in milliseconds this transition should take.
18663
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
18664
- * @property {number} opacity - This value is clamped from 0.0 to 1.0.
18665
- */
18666
- /**
18667
- * @REMOVED
18668
- * Bounds is a interface that has the properties of height,
18669
- * width, left, top which are all numbers
18670
- * @typedef { object } Bounds@typedef { object } Bounds
18671
- * @property { number } height Get the application height bound
18672
- * @property { number } width Get the application width bound
18673
- * @property { number } top Get the application top bound
18674
- * @property { number } left Get the application left bound
18675
- * @property { number } right Get the application right bound
18676
- * @property { number } bottom Get the application bottom bound
18677
- */
18678
17560
  /**
18679
17561
  * A basic window that wraps a native HTML window. Provides more fine-grained
18680
17562
  * control over the window state such as the ability to minimize, maximize, restore, etc.
@@ -18687,83 +17569,6 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
18687
17569
  * @internal
18688
17570
  */
18689
17571
  constructor(wire: Transport, identity: OpenFin.Identity);
18690
- /**
18691
- * Adds a listener to the end of the listeners array for the specified event.
18692
- * @param eventType - The type of the event.
18693
- * @param listener - Called whenever an event of the specified type occurs.
18694
- * @param options - Option to support event timestamps.
18695
- *
18696
- * @function addListener
18697
- * @memberof Window
18698
- * @instance
18699
- * @tutorial Window.EventEmitter
18700
- */
18701
- /**
18702
- * Adds a listener to the end of the listeners array for the specified event.
18703
- * @param eventType - The type of the event.
18704
- * @param listener - Called whenever an event of the specified type occurs.
18705
- * @param options - Option to support event timestamps.
18706
- *
18707
- * @function on
18708
- * @memberof Window
18709
- * @instance
18710
- * @tutorial Window.EventEmitter
18711
- */
18712
- /**
18713
- * 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.
18714
- * @param eventType - The type of the event.
18715
- * @param listener - The callback function.
18716
- * @param options - Option to support event timestamps.
18717
- *
18718
- * @function once
18719
- * @memberof Window
18720
- * @instance
18721
- * @tutorial Window.EventEmitter
18722
- */
18723
- /**
18724
- * Adds a listener to the beginning of the listeners array for the specified event.
18725
- * @param eventType - The type of the event.
18726
- * @param listener - The callback function.
18727
- * @param options - Option to support event timestamps.
18728
- *
18729
- * @function prependListener
18730
- * @memberof Window
18731
- * @instance
18732
- * @tutorial Window.EventEmitter
18733
- */
18734
- /**
18735
- * 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.
18736
- * The listener is added to the beginning of the listeners array.
18737
- * @param eventType - The type of the event.
18738
- * @param listener - The callback function.
18739
- * @param options - Option to support event timestamps.
18740
- *
18741
- * @function prependOnceListener
18742
- * @memberof Window
18743
- * @instance
18744
- * @tutorial Window.EventEmitter
18745
- */
18746
- /**
18747
- * Remove a listener from the listener array for the specified event.
18748
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
18749
- * @param eventType - The type of the event.
18750
- * @param listener - The callback function.
18751
- * @param options - Option to support event timestamps.
18752
- *
18753
- * @function removeListener
18754
- * @memberof Window
18755
- * @instance
18756
- * @tutorial Window.EventEmitter
18757
- */
18758
- /**
18759
- * Removes all listeners, or those of the specified event.
18760
- * @param eventType - The type of the event.
18761
- *
18762
- * @function removeAllListeners
18763
- * @memberof Window
18764
- * @instance
18765
- * @tutorial Window.EventEmitter
18766
- */
18767
17572
  /**
18768
17573
  * create a new window
18769
17574
  * @internal
@@ -19609,28 +18414,6 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
19609
18414
  * ```
19610
18415
  */
19611
18416
  authenticate(userName: string, password: string): Promise<void>;
19612
- /**
19613
- * @typedef {object} ShowPopupMenuOptions@typedef {object} ShowPopupMenuOptions
19614
- * @property {Array<MenuItemTemplate>} template - An array describing the menu to show.
19615
- * @property {number} [x] - The window x coordinate where to show the menu. Defaults to mouse position. If using must also use `y`.
19616
- * @property {number} [y] - The window y coordinate where to show the menu. Defaults to mouse position. If using must also use `x`
19617
- */
19618
- /**
19619
- * @typedef {object} MenuItemTemplate@typedef {object} MenuItemTemplate
19620
- * @property {*} data - Data to be returned if the user selects the element. Must be serializable. Large objects can have a performance impact.
19621
- * @property {'normal' | 'separator' | 'submenu' | 'checkbox'} [type] - Defaults to 'normal' unless a 'submenu' key exists
19622
- * @property {string} [label] - The text to show on the menu item. Should be left undefined for `type: 'separator'`
19623
- * @property {boolean} [enabled] - If false, the menu item will be greyed out and unclickable.
19624
- * @property {boolean} [visible] - If false, the menu item will be entirely hidden.
19625
- * @property {boolean} [checked] - Should only be specified for `checkbox` type menu items.
19626
- * @property {string} [icon] - Image Data URI with image dimensions inferred from the encoded string
19627
- * @property {Array<MenuItemTemplate>} [submenu] Should be specified for `submenu` type menu items. If `submenu` is specified, the `type: 'submenu'` can be omitted.
19628
- */
19629
- /**
19630
- * @typedef {object} MenuResult@typedef {object} MenuResult
19631
- * @property {'clicked' | 'closed'} result - Whether the user clicked on a menu item or the menu was closed (user clicked elsewhere).
19632
- * @property {* | undefined} [data] - The data property of the menu item clicked by the user. Only defined if result was `clicked`.
19633
- */
19634
18417
  /**
19635
18418
  * Shows a menu on the window.
19636
18419
  *
@@ -19727,590 +18510,565 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
19727
18510
  */
19728
18511
  closePopupMenu(): Promise<void>;
19729
18512
  /**
19730
- * @PORTED
19731
- * @typedef {object} PopupOptions@typedef {object} PopupOptions
19732
- * @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.
19733
- * @property {string} [url] - Navigates to this `url` if showing an existing window as a popup, otherwise the newly created window will load this `url`.
19734
- * @property {Window~options} [initialOptions] - Window creation options when using `showPopupWindow` to create a new window.
19735
- * @property {Window~options} [additionalOptions] - Updatable window options applied to new and existing windows when shown as popups.
19736
- * @property {function} [onPopupResult] - Executed when this window's popup calls `dispatchPopupResult`. Note: if this is defined, `showPopupWindow` will not return a `PopupResult`.
19737
- * @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.
19738
- * @property {number} [height] - Height of the popup window (takes priority over `intialOptions` size properties).
19739
- * @property {number} [width] - Width of the popup window (takes priority over `intialOptions` size properties).
19740
- * @property {number} [x] - Left position where the popup window will be shown (relative to the window calling `showPopupWindow`).
19741
- * @property {number} [y] - Top position where the popup window will be shown (relative to the window calling `showPopupWindow`).
19742
- * @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.
19743
- * @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`.
19744
- * @property {boolean} [focus] - Determines if the popup window should or should not be focused when it is shown.
19745
- * @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.
19746
- */
19747
- /**
19748
- * @PORTED
19749
- * @typedef {object} PopupResult@typedef {object} PopupResult
19750
- * @property {Identity} identity - `name` and `uuid` of the popup window that called dispatched this result.
19751
- * @property {'clicked' | 'dismissed'} result - Result of the user interaction with the popup window.
19752
- * @property {* | undefined} [data] - Data passed to `dispatchPopupResult`.
19753
- */
19754
- /**
19755
- * Dispatch a result to the caller of `showPopupWindow`.
19756
- *
19757
- * @remarks If this window isn't currently being shown as a popup, this call will silently fail.
19758
- * @param data Serializable data to send to the caller window.
19759
- *
19760
- * @example
19761
- * ```js
19762
- * await fin.me.dispatchPopupResult({
19763
- * foo: 'bar'
19764
- * });
19765
- * ```
19766
- */
19767
- dispatchPopupResult(data: any): Promise<void>;
19768
- /**
19769
- * Prints the contents of the window.
19770
- *
19771
- * @param options Configuration for the print task.
19772
- * @remarks When `silent` is set to `true`, the API will pick the system's default printer if deviceName is empty
19773
- * and the default settings for printing.
19774
- *
19775
- * Use the CSS style `page-break-before: always;` to force print to a new page.
19776
- *
19777
- * @example
19778
- * ```js
19779
- * const win = fin.Window.getCurrentSync();
19780
- *
19781
- * win.print({ silent: false, deviceName: 'system-printer-name' }).then(() => {
19782
- * console.log('print call has been sent to the system');
19783
- * });
19784
- * ```
19785
- *
19786
- * If a window has embedded views, those views will not print by default. To print a window's contents including embedded views,
19787
- * use the `content` option:
19788
- *
19789
- * ```js
19790
- * const win = fin.Window.getCurrentSync();
19791
- *
19792
- * // Print embedded views
19793
- * win.print({ content: 'views' });
19794
- *
19795
- * // Print screenshot of current window
19796
- * win.print({ content: 'screenshot' })
19797
- * ```
19798
- *
19799
- * When `content` is set to `views`, the embedded views in the platform window will be concatenated and printed as
19800
- * individual pages. If `includeSelf` is set to `true`, the platform window itself will be printed as the first
19801
- * page - be aware that this page will *not* include the embedded views - it will only include the contents of
19802
- * the platform window itself (e.g. tab stacks), with blank spaces where the view contents would be embedded.
19803
- *
19804
- * Due to a known issue, view contents that are not visible at the time `print` is called will not appear when
19805
- * printing `contents: views`. This includes views that are obscured behind other active UI elements.
19806
- *
19807
- * To print the views embedded in their page context, set `content` to `screenshot`.
19808
- */
19809
- print(options?: OpenFin.WindowPrintOptions): Promise<void>;
19810
- }
19811
-
19812
- /**
19813
- * Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
19814
- * @interface
19815
- */
19816
- declare type WindowAlertRequestedEvent = BaseEvent_3 & {
19817
- type: 'window-alert-requested';
19818
- };
19819
-
19820
- /**
19821
- * Returned from getBounds call. bottom and right are never used for setting.
19822
- * @interface
19823
- */
19824
- declare type WindowBounds = Bounds & {
19825
- bottom: number;
19826
- right: number;
19827
- };
19828
-
19829
- /**
19830
- * @deprecated Renamed to {@link ClosedEvent}.
19831
- */
19832
- declare type WindowClosedEvent = ClosedEvent_2;
19833
-
19834
- /**
19835
- * @deprecated Renamed to {@link CloseRequestedEvent}.
19836
- */
19837
- declare type WindowCloseRequestedEvent = CloseRequestedEvent;
19838
-
19839
- /**
19840
- * @deprecated Renamed to {@link ClosingEvent}.
19841
- */
19842
- declare type WindowClosingEvent = ClosingEvent;
19843
-
19844
- /**
19845
- * A rule prescribing content creation in a {@link OpenFin.Window}.
19846
- *
19847
- * @interface
19848
- */
19849
- declare type WindowContentCreationRule = BaseContentCreationRule & {
19850
- /**
19851
- * Behavior to use when opening matched content.
19852
- */
19853
- behavior: 'window';
19854
- /**
19855
- * Options for newly-created window.
19856
- */
19857
- options?: Partial<WindowOptions>;
19858
- };
19859
-
19860
- /**
19861
- * Generated when a child window is created.
19862
- * @interface
19863
- */
19864
- declare type WindowCreatedEvent = BaseEvent_3 & {
19865
- type: 'window-created';
19866
- };
19867
-
19868
- /**
19869
- * Options required to create a new window with {@link Window._WindowModule.create Window.create}.
19870
- *
19871
- * Note that `name` is the only required property — albeit the `url` property is usually provided as well
19872
- * (defaults to `"about:blank"` when omitted).
19873
- * @interface
19874
- */
19875
- declare type WindowCreationOptions = Partial<WindowOptions> & {
19876
- name: string;
19877
- };
19878
-
19879
- declare type WindowCreationReason = 'tearout' | 'create-view-without-target' | 'api-call' | 'app-creation' | 'restore' | 'apply-snapshot';
19880
-
19881
- /**
19882
- * @interface
19883
- */
19884
- declare type WindowDetail = {
19885
- /**
19886
- * The bottom-most coordinate of the window.
19887
- */
19888
- bottom: number;
19889
- /**
19890
- * The height of the window.
19891
- */
19892
- height: number;
19893
- isShowing: boolean;
19894
- /**
19895
- * The left-most coordinate of the window.
19896
- */
19897
- left: number;
19898
- /**
19899
- * The name of the window.
19900
- */
19901
- name: string;
19902
- /**
19903
- * The right-most coordinate of the window.
19904
- */
19905
- right: number;
19906
- state: string;
19907
- /**
19908
- * The top-most coordinate of the window.
19909
- */
19910
- top: number;
19911
- /**
19912
- * The width of the window.
19913
- */
19914
- width: number;
19915
- };
19916
-
19917
- /**
19918
- * Generated when a child window ends loading.
19919
- * @interface
19920
- */
19921
- declare type WindowEndLoadEvent = BaseEvent_3 & {
19922
- type: 'window-end-load';
19923
- };
19924
-
19925
- /**
19926
- * @deprecated, Renamed to {@link Event}.
19927
- */
19928
- declare type WindowEvent = Event_6;
19929
-
19930
- declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
19931
-
19932
- declare namespace WindowEvents {
19933
- export {
19934
- BaseEvent_5 as BaseEvent,
19935
- BaseWindowEvent,
19936
- ViewAttachedEvent,
19937
- ViewDetachedEvent,
19938
- WindowViewEvent,
19939
- AlertRequestedEvent,
19940
- AuthRequestedEvent,
19941
- EndLoadEvent,
19942
- WillRedirectEvent,
19943
- ReloadedEvent,
19944
- OptionsChangedEvent,
19945
- WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
19946
- ExternalProcessExitedEvent,
19947
- ExternalProcessStartedEvent,
19948
- HiddenEvent_2 as HiddenEvent,
19949
- WindowHiddenEvent,
19950
- PreloadScriptInfoRunning,
19951
- PreloadScriptInfo,
19952
- PreloadScriptsStateChangeEvent,
19953
- UserBoundsChangeEvent,
19954
- BoundsChangeEvent,
19955
- WillMoveOrResizeEvent,
19956
- PerformanceReportEvent,
19957
- InputEvent_2 as InputEvent,
19958
- LayoutInitializedEvent,
19959
- LayoutReadyEvent,
19960
- BeginUserBoundsChangingEvent,
19961
- BoundsChangedEvent,
19962
- BoundsChangingEvent,
19963
- CloseRequestedEvent,
19964
- WindowCloseRequestedEvent,
19965
- ContextChangedEvent,
19966
- ClosedEvent_2 as ClosedEvent,
19967
- WindowClosedEvent,
19968
- ClosingEvent,
19969
- WindowClosingEvent,
19970
- DisabledMovementBoundsChangedEvent,
19971
- DisabledMovementBoundsChangingEvent,
19972
- EmbeddedEvent,
19973
- EndUserBoundsChangingEvent,
19974
- HotkeyEvent_2 as HotkeyEvent,
19975
- WindowHotkeyEvent,
19976
- InitializedEvent_2 as InitializedEvent,
19977
- WindowInitializedEvent,
19978
- MaximizedEvent,
19979
- MinimizedEvent,
19980
- PreloadScriptsStateChangedEvent,
19981
- PreloadScriptsStateChangingEvent,
19982
- RestoredEvent,
19983
- WindowRestoredEvent,
19984
- ShowRequestedEvent,
19985
- WindowShowRequestedEvent,
19986
- ShownEvent_2 as ShownEvent,
19987
- WindowShownEvent,
19988
- UserMovementEnabledEvent,
19989
- UserMovementDisabledEvent,
19990
- WillMoveEvent,
19991
- WillResizeEvent,
19992
- NonPropagatedWindowEvent,
19993
- ShowAllDownloadsEvent,
19994
- DownloadShelfVisibilityChangedEvent,
19995
- WindowSourcedEvent,
19996
- WillPropagateWindowEvent,
19997
- Event_6 as Event,
19998
- WindowEvent,
19999
- EventType_2 as EventType,
20000
- WindowEventType,
20001
- PropagatedEvent_3 as PropagatedEvent,
20002
- PropagatedWindowEvent,
20003
- PropagatedWindowEventType,
20004
- Payload_3 as Payload,
20005
- ByType_2 as ByType
20006
- }
20007
- }
20008
-
20009
- /**
20010
- * @deprecated Renamed to {@link EventType}.
20011
- */
20012
- declare type WindowEventType = WindowEvent['type'];
20013
-
20014
- /**
20015
- * @deprecated Renamed to {@link HiddenEvent}.
20016
- */
20017
- declare type WindowHiddenEvent = HiddenEvent_2;
20018
-
20019
- /**
20020
- * @deprecated Renamed to {@link HotkeyEvent}.
20021
- */
20022
- declare type WindowHotkeyEvent = HotkeyEvent_2;
20023
-
20024
- /**
20025
- * @interface
20026
- */
20027
- declare type WindowInfo = {
20028
- canNavigateBack: boolean;
20029
- canNavigateForward: boolean;
20030
- preloadScripts: Array<any>;
20031
- title: string;
20032
- url: string;
20033
- };
20034
-
20035
- /**
20036
- * @deprecated Renamed to {@link InitializedEvent}.
20037
- */
20038
- declare type WindowInitializedEvent = InitializedEvent_2;
20039
-
20040
- /**
20041
- * Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
20042
- */
20043
- declare class _WindowModule extends Base {
20044
- /**
20045
- * Asynchronously returns a Window object that represents an existing window.
20046
- *
20047
- * @example
20048
- * ```js
20049
- * async function createWin() {
20050
- * const app = await fin.Application.start({
20051
- * name: 'myApp',
20052
- * uuid: 'app-1',
20053
- * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrap.html',
20054
- * autoShow: true
20055
- * });
20056
- * return await app.getWindow();
20057
- * }
20058
- * createWin().then(() => fin.Window.wrap({ uuid: 'app-1', name: 'myApp' }))
20059
- * .then(win => console.log('wrapped window'))
20060
- * .catch(err => console.log(err));
20061
- * ```
20062
- */
20063
- wrap(identity: OpenFin.Identity): Promise<OpenFin.Window>;
20064
- /**
20065
- * Synchronously returns a Window object that represents an existing window.
20066
- *
20067
- * @example
20068
- * ```js
20069
- * async function createWin() {
20070
- * const app = await fin.Application.start({
20071
- * name: 'myApp',
20072
- * uuid: 'app-1',
20073
- * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrapSync.html',
20074
- * autoShow: true
20075
- * });
20076
- * return await app.getWindow();
20077
- * }
20078
- * await createWin();
20079
- * let win = fin.Window.wrapSync({ uuid: 'app-1', name: 'myApp' });
20080
- * ```
20081
- */
20082
- wrapSync(identity: OpenFin.Identity): OpenFin.Window;
20083
- /**
20084
- * Creates a new Window.
20085
- * @param options - Window creation options
20086
- *
20087
- * @example
20088
- * ```js
20089
- * async function createWindow() {
20090
- * const winOption = {
20091
- * name:'child',
20092
- * defaultWidth: 300,
20093
- * defaultHeight: 300,
20094
- * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.create.html',
20095
- * frame: true,
20096
- * autoShow: true
20097
- * };
20098
- * return await fin.Window.create(winOption);
20099
- * }
20100
- *
20101
- * createWindow().then(() => console.log('Window is created')).catch(err => console.log(err));
20102
- * ```
20103
- */
20104
- create(options: OpenFin.WindowCreationOptions): Promise<OpenFin.Window>;
20105
- /**
20106
- * Asynchronously returns a Window object that represents the current window
20107
- *
20108
- * @example
20109
- * ```js
20110
- * fin.Window.getCurrent()
20111
- * .then(wnd => console.log('current window'))
20112
- * .catch(err => console.log(err));
20113
- *
20114
- * ```
20115
- */
20116
- getCurrent(): Promise<OpenFin.Window>;
20117
- /**
20118
- * Synchronously returns a Window object that represents the current window
20119
- *
20120
- * @example
20121
- * ```js
20122
- * const wnd = fin.Window.getCurrentSync();
20123
- * const info = await wnd.getInfo();
20124
- * console.log(info);
20125
- *
20126
- * ```
20127
- */
20128
- getCurrentSync(): OpenFin.Window;
20129
- }
20130
-
20131
- /**
20132
- * Generated when a child window is not responding.
20133
- * @interface
20134
- */
20135
- declare type WindowNotRespondingEvent = BaseEvent_3 & {
20136
- type: 'window-not-responding';
20137
- };
20138
-
20139
- /**
20140
- * @interface
20141
- */
20142
- declare type WindowOptionDiff = {
20143
- [key in keyof WindowOptions]: {
20144
- oldVal: WindowOptions[key];
20145
- newVal: WindowOptions[key];
20146
- };
20147
- };
20148
-
20149
- /**
20150
- * @interface
20151
- */
20152
- declare type WindowOptions = MutableWindowOptions & ConstWindowOptions;
20153
-
20154
- declare type WindowOptionsChangedEvent = OpenFin.WindowEvents.WindowOptionsChangedEvent;
20155
-
20156
- /**
20157
- * @deprecated Renamed to {@link OptionsChangedEvent}.
20158
- */
20159
- declare type WindowOptionsChangedEvent_2 = OptionsChangedEvent;
20160
-
20161
- declare type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
20162
-
20163
- /**
20164
- * Generated when a child window is responding.
20165
- * @interface
20166
- */
20167
- declare type WindowRespondingEvent = BaseEvent_3 & {
20168
- type: 'window-responding';
20169
- };
20170
-
20171
- /**
20172
- * @deprecated Renamed to {@link RestoredEvent}.
20173
- */
20174
- declare type WindowRestoredEvent = RestoredEvent;
20175
-
20176
- /**
20177
- * @deprecated Renamed to {@link ShownEvent}.
20178
- */
20179
- declare type WindowShownEvent = ShownEvent_2;
20180
-
20181
- /**
20182
- * @deprecated Renamed to {@link ShowRequestedEvent}.
20183
- */
20184
- declare type WindowShowRequestedEvent = ShowRequestedEvent;
20185
-
20186
- /**
20187
- * A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
20188
- * from {@link OpenFin.ViewEvents}.
20189
- */
20190
- 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;
20191
-
20192
- /**
20193
- * Generated when a child window starts loading.
20194
- * @interface
20195
- */
20196
- declare type WindowStartLoadEvent = BaseEvent_3 & {
20197
- type: 'window-start-load';
20198
- };
20199
-
20200
- /**
20201
- * Visibility state of a window.
20202
- */
20203
- declare type WindowState = 'maximized' | 'minimized' | 'normal';
20204
-
20205
- /**
20206
- * A view-related event that fires natively on the `Window` topic. This means that these events *do* propagate
20207
- * to the `Application` level, with the name pattern `window-view-eventname`.
20208
- */
20209
- declare type WindowViewEvent = {
20210
- viewIdentity: OpenFin.Identity;
20211
- } & (ViewAttachedEvent | ViewDetachedEvent);
20212
-
20213
- /**
20214
- * @interface
20215
- */
20216
- declare type WindowViewsPrintOptions = {
20217
- content: 'views';
20218
- includeSelf?: boolean;
20219
- };
20220
-
20221
- declare type Wire = EventEmitter & {
20222
- connect(messageReciever: MessageReceiver): Promise<any>;
20223
- connectSync(): any;
20224
- send(data: any): Promise<any>;
20225
- shutdown(): Promise<void>;
20226
- getPort(): string;
20227
- };
20228
-
20229
- declare type WireConstructor = {
20230
- new (onmessage: (data: any) => void): Wire;
20231
- };
20232
-
20233
- /**
20234
- * @internal
20235
- */
20236
- declare type WithId<T extends AppVersionEventType> = `${T}.${string}`;
20237
-
20238
- declare interface WithInterop {
20239
- interop: InteropClient;
20240
- }
20241
-
20242
- /**
20243
- * @internal
20244
- */
20245
- declare type WithoutId<T extends string> = T extends WithId<infer U> ? U : never;
20246
-
20247
- declare type WithPositioningOptions<T extends {} = {}> = T & {
20248
- positioningOptions?: OpenFin.PositioningOptions;
20249
- };
20250
-
20251
- /**
20252
- * @internal
20253
- * @interface
20254
- */
20255
- declare type WorkspacePlatformOptions = {
20256
- /** Leaving this as any for now until we figure out what the shape should look like in Workspace */
20257
- [key: string]: any;
20258
- };
20259
-
20260
- /**
20261
- * A generic request to write any supported data to the clipboard.
20262
- * @interface
20263
- */
20264
- declare type WriteAnyClipboardRequest = BaseClipboardRequest & {
20265
- /**
20266
- * Data to be written
20267
- */
20268
- data: {
20269
- text?: string;
20270
- html?: string;
20271
- rtf?: string;
20272
- } & Partial<Pick<WriteImageClipboardRequest, 'image'>>;
20273
- };
20274
-
20275
- /**
20276
- * @deprecated - instead use WriteAnyClipboardRequest
20277
- *
20278
- * A generic request to write any supported data to the clipboard.
20279
- *
20280
- * @interface
20281
- */
20282
- declare type WriteAnyRequestType = WriteAnyClipboardRequest;
20283
-
20284
- /**
20285
- * A request to write data to the clipboard.
20286
- * @interface
20287
- */
20288
- declare type WriteClipboardRequest = BaseClipboardRequest & {
20289
- /**
20290
- * Data to write to the clipboard.
20291
- */
20292
- data: string;
20293
- };
20294
-
20295
- /**
20296
- * @interface
20297
- */
20298
- declare type WriteImageClipboardRequest = BaseClipboardRequest & {
20299
- /**
20300
- * Can be either a base64 string, or a DataURL string. If using DataURL, the
20301
- * supported formats are `data:image/png[;base64],` and `data:image/jpeg[;base64],`.
20302
- * Using other image/<format> DataURLs will throw an Error.
20303
- */
20304
- image: string;
20305
- };
20306
-
20307
- /**
20308
- * @deprecated - instead use OpenFin.WriteClipboardRequest
20309
- *
20310
- * A request to write data to the clipboard.
20311
- *
20312
- * @interface
20313
- */
20314
- declare type WriteRequestType = WriteClipboardRequest;
20315
-
20316
- export { }
18513
+ * Dispatch a result to the caller of `showPopupWindow`.
18514
+ *
18515
+ * @remarks If this window isn't currently being shown as a popup, this call will silently fail.
18516
+ * @param data Serializable data to send to the caller window.
18517
+ *
18518
+ * @example
18519
+ * ```js
18520
+ * await fin.me.dispatchPopupResult({
18521
+ * foo: 'bar'
18522
+ * });
18523
+ * ```
18524
+ */
18525
+ dispatchPopupResult(data: any): Promise<void>;
18526
+ /**
18527
+ * Prints the contents of the window.
18528
+ *
18529
+ * @param options Configuration for the print task.
18530
+ * @remarks When `silent` is set to `true`, the API will pick the system's default printer if deviceName is empty
18531
+ * and the default settings for printing.
18532
+ *
18533
+ * Use the CSS style `page-break-before: always;` to force print to a new page.
18534
+ *
18535
+ * @example
18536
+ * ```js
18537
+ * const win = fin.Window.getCurrentSync();
18538
+ *
18539
+ * win.print({ silent: false, deviceName: 'system-printer-name' }).then(() => {
18540
+ * console.log('print call has been sent to the system');
18541
+ * });
18542
+ * ```
18543
+ *
18544
+ * If a window has embedded views, those views will not print by default. To print a window's contents including embedded views,
18545
+ * use the `content` option:
18546
+ *
18547
+ * ```js
18548
+ * const win = fin.Window.getCurrentSync();
18549
+ *
18550
+ * // Print embedded views
18551
+ * win.print({ content: 'views' });
18552
+ *
18553
+ * // Print screenshot of current window
18554
+ * win.print({ content: 'screenshot' })
18555
+ * ```
18556
+ *
18557
+ * When `content` is set to `views`, the embedded views in the platform window will be concatenated and printed as
18558
+ * individual pages. If `includeSelf` is set to `true`, the platform window itself will be printed as the first
18559
+ * page - be aware that this page will *not* include the embedded views - it will only include the contents of
18560
+ * the platform window itself (e.g. tab stacks), with blank spaces where the view contents would be embedded.
18561
+ *
18562
+ * Due to a known issue, view contents that are not visible at the time `print` is called will not appear when
18563
+ * printing `contents: views`. This includes views that are obscured behind other active UI elements.
18564
+ *
18565
+ * To print the views embedded in their page context, set `content` to `screenshot`.
18566
+ */
18567
+ print(options?: OpenFin.WindowPrintOptions): Promise<void>;
18568
+ }
18569
+
18570
+ /**
18571
+ * Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
18572
+ * @interface
18573
+ */
18574
+ declare type WindowAlertRequestedEvent = BaseEvent_3 & {
18575
+ type: 'window-alert-requested';
18576
+ };
18577
+
18578
+ /**
18579
+ * Returned from getBounds call. bottom and right are never used for setting.
18580
+ * @interface
18581
+ */
18582
+ declare type WindowBounds = Bounds & {
18583
+ bottom: number;
18584
+ right: number;
18585
+ };
18586
+
18587
+ /**
18588
+ * @deprecated Renamed to {@link ClosedEvent}.
18589
+ */
18590
+ declare type WindowClosedEvent = ClosedEvent_2;
18591
+
18592
+ /**
18593
+ * @deprecated Renamed to {@link CloseRequestedEvent}.
18594
+ */
18595
+ declare type WindowCloseRequestedEvent = CloseRequestedEvent;
18596
+
18597
+ /**
18598
+ * @deprecated Renamed to {@link ClosingEvent}.
18599
+ */
18600
+ declare type WindowClosingEvent = ClosingEvent;
18601
+
18602
+ /**
18603
+ * A rule prescribing content creation in a {@link OpenFin.Window}.
18604
+ *
18605
+ * @interface
18606
+ */
18607
+ declare type WindowContentCreationRule = BaseContentCreationRule & {
18608
+ /**
18609
+ * Behavior to use when opening matched content.
18610
+ */
18611
+ behavior: 'window';
18612
+ /**
18613
+ * Options for newly-created window.
18614
+ */
18615
+ options?: Partial<WindowOptions>;
18616
+ };
18617
+
18618
+ /**
18619
+ * Generated when a child window is created.
18620
+ * @interface
18621
+ */
18622
+ declare type WindowCreatedEvent = BaseEvent_3 & {
18623
+ type: 'window-created';
18624
+ };
18625
+
18626
+ /**
18627
+ * Options required to create a new window with {@link Window._WindowModule.create Window.create}.
18628
+ *
18629
+ * Note that `name` is the only required property — albeit the `url` property is usually provided as well
18630
+ * (defaults to `"about:blank"` when omitted).
18631
+ * @interface
18632
+ */
18633
+ declare type WindowCreationOptions = Partial<WindowOptions> & {
18634
+ name: string;
18635
+ };
18636
+
18637
+ declare type WindowCreationReason = 'tearout' | 'create-view-without-target' | 'api-call' | 'app-creation' | 'restore' | 'apply-snapshot';
18638
+
18639
+ /**
18640
+ * @interface
18641
+ */
18642
+ declare type WindowDetail = {
18643
+ /**
18644
+ * The bottom-most coordinate of the window.
18645
+ */
18646
+ bottom: number;
18647
+ /**
18648
+ * The height of the window.
18649
+ */
18650
+ height: number;
18651
+ isShowing: boolean;
18652
+ /**
18653
+ * The left-most coordinate of the window.
18654
+ */
18655
+ left: number;
18656
+ /**
18657
+ * The name of the window.
18658
+ */
18659
+ name: string;
18660
+ /**
18661
+ * The right-most coordinate of the window.
18662
+ */
18663
+ right: number;
18664
+ state: string;
18665
+ /**
18666
+ * The top-most coordinate of the window.
18667
+ */
18668
+ top: number;
18669
+ /**
18670
+ * The width of the window.
18671
+ */
18672
+ width: number;
18673
+ };
18674
+
18675
+ /**
18676
+ * Generated when a child window ends loading.
18677
+ * @interface
18678
+ */
18679
+ declare type WindowEndLoadEvent = BaseEvent_3 & {
18680
+ type: 'window-end-load';
18681
+ };
18682
+
18683
+ /**
18684
+ * @deprecated, Renamed to {@link Event}.
18685
+ */
18686
+ declare type WindowEvent = Event_6;
18687
+
18688
+ declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
18689
+
18690
+ declare namespace WindowEvents {
18691
+ export {
18692
+ BaseEvent_5 as BaseEvent,
18693
+ BaseWindowEvent,
18694
+ ViewAttachedEvent,
18695
+ ViewDetachedEvent,
18696
+ WindowViewEvent,
18697
+ AlertRequestedEvent,
18698
+ AuthRequestedEvent,
18699
+ EndLoadEvent,
18700
+ WillRedirectEvent,
18701
+ ReloadedEvent,
18702
+ OptionsChangedEvent,
18703
+ WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
18704
+ ExternalProcessExitedEvent,
18705
+ ExternalProcessStartedEvent,
18706
+ HiddenEvent_2 as HiddenEvent,
18707
+ WindowHiddenEvent,
18708
+ PreloadScriptInfoRunning,
18709
+ PreloadScriptInfo,
18710
+ PreloadScriptsStateChangeEvent,
18711
+ UserBoundsChangeEvent,
18712
+ BoundsChangeEvent,
18713
+ WillMoveOrResizeEvent,
18714
+ PerformanceReportEvent,
18715
+ InputEvent_2 as InputEvent,
18716
+ LayoutInitializedEvent,
18717
+ LayoutReadyEvent,
18718
+ BeginUserBoundsChangingEvent,
18719
+ BoundsChangedEvent,
18720
+ BoundsChangingEvent,
18721
+ CloseRequestedEvent,
18722
+ WindowCloseRequestedEvent,
18723
+ ContextChangedEvent,
18724
+ ClosedEvent_2 as ClosedEvent,
18725
+ WindowClosedEvent,
18726
+ ClosingEvent,
18727
+ WindowClosingEvent,
18728
+ DisabledMovementBoundsChangedEvent,
18729
+ DisabledMovementBoundsChangingEvent,
18730
+ EmbeddedEvent,
18731
+ EndUserBoundsChangingEvent,
18732
+ HotkeyEvent_2 as HotkeyEvent,
18733
+ WindowHotkeyEvent,
18734
+ InitializedEvent_2 as InitializedEvent,
18735
+ WindowInitializedEvent,
18736
+ MaximizedEvent,
18737
+ MinimizedEvent,
18738
+ PreloadScriptsStateChangedEvent,
18739
+ PreloadScriptsStateChangingEvent,
18740
+ RestoredEvent,
18741
+ WindowRestoredEvent,
18742
+ ShowRequestedEvent,
18743
+ WindowShowRequestedEvent,
18744
+ ShownEvent_2 as ShownEvent,
18745
+ WindowShownEvent,
18746
+ UserMovementEnabledEvent,
18747
+ UserMovementDisabledEvent,
18748
+ WillMoveEvent,
18749
+ WillResizeEvent,
18750
+ NonPropagatedWindowEvent,
18751
+ ShowAllDownloadsEvent,
18752
+ DownloadShelfVisibilityChangedEvent,
18753
+ WindowSourcedEvent,
18754
+ WillPropagateWindowEvent,
18755
+ Event_6 as Event,
18756
+ WindowEvent,
18757
+ EventType_2 as EventType,
18758
+ WindowEventType,
18759
+ PropagatedEvent_3 as PropagatedEvent,
18760
+ PropagatedWindowEvent,
18761
+ PropagatedWindowEventType,
18762
+ Payload_3 as Payload,
18763
+ ByType_2 as ByType
18764
+ }
18765
+ }
18766
+
18767
+ /**
18768
+ * @deprecated Renamed to {@link EventType}.
18769
+ */
18770
+ declare type WindowEventType = WindowEvent['type'];
18771
+
18772
+ /**
18773
+ * @deprecated Renamed to {@link HiddenEvent}.
18774
+ */
18775
+ declare type WindowHiddenEvent = HiddenEvent_2;
18776
+
18777
+ /**
18778
+ * @deprecated Renamed to {@link HotkeyEvent}.
18779
+ */
18780
+ declare type WindowHotkeyEvent = HotkeyEvent_2;
18781
+
18782
+ /**
18783
+ * @interface
18784
+ */
18785
+ declare type WindowInfo = {
18786
+ canNavigateBack: boolean;
18787
+ canNavigateForward: boolean;
18788
+ preloadScripts: Array<any>;
18789
+ title: string;
18790
+ url: string;
18791
+ };
18792
+
18793
+ /**
18794
+ * @deprecated Renamed to {@link InitializedEvent}.
18795
+ */
18796
+ declare type WindowInitializedEvent = InitializedEvent_2;
18797
+
18798
+ /**
18799
+ * Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
18800
+ */
18801
+ declare class _WindowModule extends Base {
18802
+ /**
18803
+ * Asynchronously returns a Window object that represents an existing window.
18804
+ *
18805
+ * @example
18806
+ * ```js
18807
+ * async function createWin() {
18808
+ * const app = await fin.Application.start({
18809
+ * name: 'myApp',
18810
+ * uuid: 'app-1',
18811
+ * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrap.html',
18812
+ * autoShow: true
18813
+ * });
18814
+ * return await app.getWindow();
18815
+ * }
18816
+ * createWin().then(() => fin.Window.wrap({ uuid: 'app-1', name: 'myApp' }))
18817
+ * .then(win => console.log('wrapped window'))
18818
+ * .catch(err => console.log(err));
18819
+ * ```
18820
+ */
18821
+ wrap(identity: OpenFin.Identity): Promise<OpenFin.Window>;
18822
+ /**
18823
+ * Synchronously returns a Window object that represents an existing window.
18824
+ *
18825
+ * @example
18826
+ * ```js
18827
+ * async function createWin() {
18828
+ * const app = await fin.Application.start({
18829
+ * name: 'myApp',
18830
+ * uuid: 'app-1',
18831
+ * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrapSync.html',
18832
+ * autoShow: true
18833
+ * });
18834
+ * return await app.getWindow();
18835
+ * }
18836
+ * await createWin();
18837
+ * let win = fin.Window.wrapSync({ uuid: 'app-1', name: 'myApp' });
18838
+ * ```
18839
+ */
18840
+ wrapSync(identity: OpenFin.Identity): OpenFin.Window;
18841
+ /**
18842
+ * Creates a new Window.
18843
+ * @param options - Window creation options
18844
+ *
18845
+ * @example
18846
+ * ```js
18847
+ * async function createWindow() {
18848
+ * const winOption = {
18849
+ * name:'child',
18850
+ * defaultWidth: 300,
18851
+ * defaultHeight: 300,
18852
+ * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.create.html',
18853
+ * frame: true,
18854
+ * autoShow: true
18855
+ * };
18856
+ * return await fin.Window.create(winOption);
18857
+ * }
18858
+ *
18859
+ * createWindow().then(() => console.log('Window is created')).catch(err => console.log(err));
18860
+ * ```
18861
+ */
18862
+ create(options: OpenFin.WindowCreationOptions): Promise<OpenFin.Window>;
18863
+ /**
18864
+ * Asynchronously returns a Window object that represents the current window
18865
+ *
18866
+ * @example
18867
+ * ```js
18868
+ * fin.Window.getCurrent()
18869
+ * .then(wnd => console.log('current window'))
18870
+ * .catch(err => console.log(err));
18871
+ *
18872
+ * ```
18873
+ */
18874
+ getCurrent(): Promise<OpenFin.Window>;
18875
+ /**
18876
+ * Synchronously returns a Window object that represents the current window
18877
+ *
18878
+ * @example
18879
+ * ```js
18880
+ * const wnd = fin.Window.getCurrentSync();
18881
+ * const info = await wnd.getInfo();
18882
+ * console.log(info);
18883
+ *
18884
+ * ```
18885
+ */
18886
+ getCurrentSync(): OpenFin.Window;
18887
+ }
18888
+
18889
+ /**
18890
+ * Generated when a child window is not responding.
18891
+ * @interface
18892
+ */
18893
+ declare type WindowNotRespondingEvent = BaseEvent_3 & {
18894
+ type: 'window-not-responding';
18895
+ };
18896
+
18897
+ /**
18898
+ * @interface
18899
+ */
18900
+ declare type WindowOptionDiff = {
18901
+ [key in keyof WindowOptions]: {
18902
+ oldVal: WindowOptions[key];
18903
+ newVal: WindowOptions[key];
18904
+ };
18905
+ };
18906
+
18907
+ /**
18908
+ * @interface
18909
+ */
18910
+ declare type WindowOptions = MutableWindowOptions & ConstWindowOptions;
18911
+
18912
+ declare type WindowOptionsChangedEvent = OpenFin.WindowEvents.WindowOptionsChangedEvent;
18913
+
18914
+ /**
18915
+ * @deprecated Renamed to {@link OptionsChangedEvent}.
18916
+ */
18917
+ declare type WindowOptionsChangedEvent_2 = OptionsChangedEvent;
18918
+
18919
+ declare type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
18920
+
18921
+ /**
18922
+ * Generated when a child window is responding.
18923
+ * @interface
18924
+ */
18925
+ declare type WindowRespondingEvent = BaseEvent_3 & {
18926
+ type: 'window-responding';
18927
+ };
18928
+
18929
+ /**
18930
+ * @deprecated Renamed to {@link RestoredEvent}.
18931
+ */
18932
+ declare type WindowRestoredEvent = RestoredEvent;
18933
+
18934
+ /**
18935
+ * @deprecated Renamed to {@link ShownEvent}.
18936
+ */
18937
+ declare type WindowShownEvent = ShownEvent_2;
18938
+
18939
+ /**
18940
+ * @deprecated Renamed to {@link ShowRequestedEvent}.
18941
+ */
18942
+ declare type WindowShowRequestedEvent = ShowRequestedEvent;
18943
+
18944
+ /**
18945
+ * A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
18946
+ * from {@link OpenFin.ViewEvents}.
18947
+ */
18948
+ 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;
18949
+
18950
+ /**
18951
+ * Generated when a child window starts loading.
18952
+ * @interface
18953
+ */
18954
+ declare type WindowStartLoadEvent = BaseEvent_3 & {
18955
+ type: 'window-start-load';
18956
+ };
18957
+
18958
+ /**
18959
+ * Visibility state of a window.
18960
+ */
18961
+ declare type WindowState = 'maximized' | 'minimized' | 'normal';
18962
+
18963
+ /**
18964
+ * A view-related event that fires natively on the `Window` topic. This means that these events *do* propagate
18965
+ * to the `Application` level, with the name pattern `window-view-eventname`.
18966
+ */
18967
+ declare type WindowViewEvent = {
18968
+ viewIdentity: OpenFin.Identity;
18969
+ } & (ViewAttachedEvent | ViewDetachedEvent);
18970
+
18971
+ /**
18972
+ * @interface
18973
+ */
18974
+ declare type WindowViewsPrintOptions = {
18975
+ content: 'views';
18976
+ includeSelf?: boolean;
18977
+ };
18978
+
18979
+ declare type Wire = EventEmitter & {
18980
+ connect(messageReciever: MessageReceiver): Promise<any>;
18981
+ connectSync(): any;
18982
+ send(data: any): Promise<any>;
18983
+ shutdown(): Promise<void>;
18984
+ getPort(): string;
18985
+ };
18986
+
18987
+ declare type WireConstructor = {
18988
+ new (onmessage: (data: any) => void): Wire;
18989
+ };
18990
+
18991
+ /**
18992
+ * @internal
18993
+ */
18994
+ declare type WithId<T extends AppVersionEventType> = `${T}.${string}`;
18995
+
18996
+ declare interface WithInterop {
18997
+ interop: InteropClient;
18998
+ }
18999
+
19000
+ /**
19001
+ * @internal
19002
+ */
19003
+ declare type WithoutId<T extends string> = T extends WithId<infer U> ? U : never;
19004
+
19005
+ declare type WithPositioningOptions<T extends {} = {}> = T & {
19006
+ positioningOptions?: OpenFin.PositioningOptions;
19007
+ };
19008
+
19009
+ /**
19010
+ * @internal
19011
+ * @interface
19012
+ */
19013
+ declare type WorkspacePlatformOptions = {
19014
+ /** Leaving this as any for now until we figure out what the shape should look like in Workspace */
19015
+ [key: string]: any;
19016
+ };
19017
+
19018
+ /**
19019
+ * A generic request to write any supported data to the clipboard.
19020
+ * @interface
19021
+ */
19022
+ declare type WriteAnyClipboardRequest = BaseClipboardRequest & {
19023
+ /**
19024
+ * Data to be written
19025
+ */
19026
+ data: {
19027
+ text?: string;
19028
+ html?: string;
19029
+ rtf?: string;
19030
+ } & Partial<Pick<WriteImageClipboardRequest, 'image'>>;
19031
+ };
19032
+
19033
+ /**
19034
+ * @deprecated - instead use WriteAnyClipboardRequest
19035
+ *
19036
+ * A generic request to write any supported data to the clipboard.
19037
+ *
19038
+ * @interface
19039
+ */
19040
+ declare type WriteAnyRequestType = WriteAnyClipboardRequest;
19041
+
19042
+ /**
19043
+ * A request to write data to the clipboard.
19044
+ * @interface
19045
+ */
19046
+ declare type WriteClipboardRequest = BaseClipboardRequest & {
19047
+ /**
19048
+ * Data to write to the clipboard.
19049
+ */
19050
+ data: string;
19051
+ };
19052
+
19053
+ /**
19054
+ * @interface
19055
+ */
19056
+ declare type WriteImageClipboardRequest = BaseClipboardRequest & {
19057
+ /**
19058
+ * Can be either a base64 string, or a DataURL string. If using DataURL, the
19059
+ * supported formats are `data:image/png[;base64],` and `data:image/jpeg[;base64],`.
19060
+ * Using other image/<format> DataURLs will throw an Error.
19061
+ */
19062
+ image: string;
19063
+ };
19064
+
19065
+ /**
19066
+ * @deprecated - instead use OpenFin.WriteClipboardRequest
19067
+ *
19068
+ * A request to write data to the clipboard.
19069
+ *
19070
+ * @interface
19071
+ */
19072
+ declare type WriteRequestType = WriteClipboardRequest;
19073
+
19074
+ export { }