@openfin/node-adapter 35.78.16 → 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.
@@ -189,100 +189,6 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
189
189
  private window;
190
190
  /* Excluded from this release type: __constructor */
191
191
  private windowListFromIdentityList;
192
- /**
193
- * Adds a listener to the end of the listeners array for the specified event.
194
- * @param eventType - The type of the event.
195
- * @param listener - Called whenever an event of the specified type occurs.
196
- * @param options - Option to support event timestamps.
197
- *
198
- * @function addListener
199
- * @memberof Application
200
- * @instance
201
- * @tutorial Application.EventEmitter
202
- */
203
- /**
204
- * Adds a listener to the end of the listeners array for the specified event.
205
- * @param eventType - The type of the event.
206
- * @param listener - Called whenever an event of the specified type occurs.
207
- * @param options - Option to support event timestamps.
208
- *
209
- * @function on
210
- * @memberof Application
211
- * @instance
212
- * @tutorial Application.EventEmitter
213
- */
214
- /**
215
- * 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.
216
- * @param eventType - The type of the event.
217
- * @param listener - The callback function.
218
- * @param options - Option to support event timestamps.
219
- *
220
- * @function once
221
- * @memberof Application
222
- * @instance
223
- * @tutorial Application.EventEmitter
224
- */
225
- /**
226
- * Adds a listener to the beginning of the listeners array for the specified event.
227
- * @param eventType - The type of the event.
228
- * @param listener - The callback function.
229
- * @param options - Option to support event timestamps.
230
- *
231
- * @function prependListener
232
- * @memberof Application
233
- * @instance
234
- * @tutorial Application.EventEmitter
235
- */
236
- /**
237
- * 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.
238
- * The listener is added to the beginning of the listeners array.
239
- * @param eventType - The type of the event.
240
- * @param listener - The callback function.
241
- * @param options - Option to support event timestamps.
242
- *
243
- * @function prependOnceListener
244
- * @memberof Application
245
- * @instance
246
- * @tutorial Application.EventEmitter
247
- */
248
- /**
249
- * Remove a listener from the listener array for the specified event.
250
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
251
- * @param eventType - The type of the event.
252
- * @param listener - The callback function.
253
- * @param options - Option to support event timestamps.
254
- *
255
- * @function removeListener
256
- * @memberof Application
257
- * @instance
258
- * @tutorial Application.EventEmitter
259
- */
260
- /**
261
- * Removes all listeners, or those of the specified event.
262
- * @param eventType - The type of the event.
263
- *
264
- * @function removeAllListeners
265
- * @memberof Application
266
- * @instance
267
- * @tutorial Application.EventEmitter
268
- */
269
- /**
270
- * JumpListCategory interface
271
- * @typedef { object } JumpListCategory@typedef { object } JumpListCategory
272
- * @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.
273
- * @property { JumpListItem[] } items Array of JumpListItem objects
274
- */
275
- /**
276
- * @PORTED
277
- * JumpListItem interface
278
- * @typedef { object } JumpListItem@typedef { object } JumpListItem
279
- * @property { string } type One of the following: "task" or "separator". Defaults to task.
280
- * @property { string } title The text to be displayed for the JumpList Item. Should only be set if type is "task".
281
- * @property { string } description Description of the task (displayed in a tooltip). Should only be set if type is "task".
282
- * @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.
283
- * @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).
284
- * @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.
285
- */
286
192
  /**
287
193
  * Determines if the application is currently running.
288
194
  *
@@ -3110,20 +3016,6 @@ declare type ClientInfo = Omit<ClientIdentity, 'isLocalEndpointId'> & {
3110
3016
  connectionUrl: string;
3111
3017
  };
3112
3018
 
3113
- /**
3114
- * @PORTED
3115
- * WriteRequestType interface
3116
- * @typedef { object } WriteRequestType@typedef { object } WriteRequestType
3117
- * @property { string } data Data to be written
3118
- * @property { string } [type] Clipboard Type
3119
- */
3120
- /**
3121
- * @PORTED
3122
- * OpenFin.WriteAnyClipboardRequest interface
3123
- * @typedef { object } OpenFin.WriteAnyClipboardRequest@typedef { object } OpenFin.WriteAnyClipboardRequest
3124
- * @property { string } data Data to be written
3125
- * @property { OpenFin.ClipboardSelectionType } [type] Clipboard Type defaults to 'clipboard', use 'selection' for linux
3126
- */
3127
3019
  /**
3128
3020
  * The Clipboard API allows reading and writing to the clipboard in multiple formats.
3129
3021
  *
@@ -5331,83 +5223,6 @@ declare type ExitCode = {
5331
5223
  declare class ExternalApplication extends EmitterBase<OpenFin.ExternalApplicationEvent> {
5332
5224
  identity: OpenFin.ApplicationIdentity;
5333
5225
  /* Excluded from this release type: __constructor */
5334
- /**
5335
- * Adds a listener to the end of the listeners array for the specified event.
5336
- * @param eventType - The type of the event.
5337
- * @param listener - Called whenever an event of the specified type occurs.
5338
- * @param options - Option to support event timestamps.
5339
- *
5340
- * @function addListener
5341
- * @memberof ExternalApplication
5342
- * @instance
5343
- * @tutorial ExternalApplication.EventEmitter
5344
- */
5345
- /**
5346
- * Adds a listener to the end of the listeners array for the specified event.
5347
- * @param eventType - The type of the event.
5348
- * @param listener - Called whenever an event of the specified type occurs.
5349
- * @param options - Option to support event timestamps.
5350
- *
5351
- * @function on
5352
- * @memberof ExternalApplication
5353
- * @instance
5354
- * @tutorial ExternalApplication.EventEmitter
5355
- */
5356
- /**
5357
- * 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.
5358
- * @param eventType - The type of the event.
5359
- * @param listener - The callback function.
5360
- * @param options - Option to support event timestamps.
5361
- *
5362
- * @function once
5363
- * @memberof ExternalApplication
5364
- * @instance
5365
- * @tutorial ExternalApplication.EventEmitter
5366
- */
5367
- /**
5368
- * Adds a listener to the beginning of the listeners array for the specified event.
5369
- * @param eventType - The type of the event.
5370
- * @param listener - The callback function.
5371
- * @param options - Option to support event timestamps.
5372
- *
5373
- * @function prependListener
5374
- * @memberof ExternalApplication
5375
- * @instance
5376
- * @tutorial ExternalApplication.EventEmitter
5377
- */
5378
- /**
5379
- * 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.
5380
- * The listener is added to the beginning of the listeners array.
5381
- * @param eventType - The type of the event.
5382
- * @param listener - The callback function.
5383
- * @param options - Option to support event timestamps.
5384
- *
5385
- * @function prependOnceListener
5386
- * @memberof ExternalApplication
5387
- * @instance
5388
- * @tutorial ExternalApplication.EventEmitter
5389
- */
5390
- /**
5391
- * Remove a listener from the listener array for the specified event.
5392
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
5393
- * @param eventType - The type of the event.
5394
- * @param listener - The callback function.
5395
- * @param options - Option to support event timestamps.
5396
- *
5397
- * @function removeListener
5398
- * @memberof ExternalApplication
5399
- * @instance
5400
- * @tutorial ExternalApplication.EventEmitter
5401
- */
5402
- /**
5403
- * Removes all listeners, or those of the specified event.
5404
- * @param eventType - The type of the event.
5405
- *
5406
- * @function removeAllListeners
5407
- * @memberof ExternalApplication
5408
- * @instance
5409
- * @tutorial ExternalApplication.EventEmitter
5410
- */
5411
5226
  /**
5412
5227
  * Retrieves information about the external application.
5413
5228
  *
@@ -5827,83 +5642,6 @@ declare type FoundInPageEvent = NamedEvent & {
5827
5642
  declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
5828
5643
  identity: OpenFin.Identity;
5829
5644
  /* Excluded from this release type: __constructor */
5830
- /**
5831
- * Adds the listener function to the end of the listeners array for the specified event type.
5832
- * @param eventType - The type of the event.
5833
- * @param listener - Called whenever an event of the specified type occurs.
5834
- * @param options - Option to support event timestamps.
5835
- *
5836
- * @function addListener
5837
- * @memberof Frame
5838
- * @instance
5839
- * @tutorial Frame.EventEmitter
5840
- */
5841
- /**
5842
- * Adds a listener to the end of the listeners array for the specified event.
5843
- * @param eventType - The type of the event.
5844
- * @param listener - Called whenever an event of the specified type occurs.
5845
- * @param options - Option to support event timestamps.
5846
- *
5847
- * @function on
5848
- * @memberof Frame
5849
- * @instance
5850
- * @tutorial Frame.EventEmitter
5851
- */
5852
- /**
5853
- * 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.
5854
- * @param eventType - The type of the event.
5855
- * @param listener - The callback function.
5856
- * @param options - Option to support event timestamps.
5857
- *
5858
- * @function once
5859
- * @memberof Frame
5860
- * @instance
5861
- * @tutorial Frame.EventEmitter
5862
- */
5863
- /**
5864
- * Adds a listener to the beginning of the listeners array for the specified event.
5865
- * @param eventType - The type of the event.
5866
- * @param listener - The callback function.
5867
- * @param options - Option to support event timestamps.
5868
- *
5869
- * @function prependListener
5870
- * @memberof Frame
5871
- * @instance
5872
- * @tutorial Frame.EventEmitter
5873
- */
5874
- /**
5875
- * 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.
5876
- * The listener is added to the beginning of the listeners array.
5877
- * @param eventType - The type of the event.
5878
- * @param listener - The callback function.
5879
- * @param options - Option to support event timestamps.
5880
- *
5881
- * @function prependOnceListener
5882
- * @memberof Frame
5883
- * @instance
5884
- * @tutorial Frame.EventEmitter
5885
- */
5886
- /**
5887
- * Remove a listener from the listener array for the specified event.
5888
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
5889
- * @param eventType - The type of the event.
5890
- * @param listener - The callback function.
5891
- * @param options - Option to support event timestamps.
5892
- *
5893
- * @function removeListener
5894
- * @memberof Frame
5895
- * @instance
5896
- * @tutorial Frame.EventEmitter
5897
- */
5898
- /**
5899
- * Removes all listeners, or those of the specified event.
5900
- * @param eventType - The type of the event.
5901
- *
5902
- * @function removeAllListeners
5903
- * @memberof Frame
5904
- * @instance
5905
- * @tutorial Frame.EventEmitter
5906
- */
5907
5645
  /**
5908
5646
  * Returns a frame info object for the represented frame.
5909
5647
  *
@@ -7166,56 +6904,6 @@ declare class InteropBroker extends Base {
7166
6904
  static createClosedConstructor(...args: ConstructorParameters<typeof InteropBroker>): {
7167
6905
  new (): InteropBroker;
7168
6906
  };
7169
- /**
7170
- * @REMOVED
7171
- * SetContextOptions interface
7172
- * @typedef { object } SetContextOptions@typedef { object } SetContextOptions
7173
- * @property { Context } {context} - New context to set.
7174
- */
7175
- /**
7176
- * @REMOVED
7177
- * GetContextOptions interface
7178
- * @typedef { object } GetContextOptions@typedef { object } GetContextOptions
7179
- * @property { string } [contextType] - Context Type
7180
- */
7181
- /**
7182
- * @REMOVED
7183
- * JoinContextGroupOptions interface
7184
- * @typedef { object } JoinContextGroupOptions@typedef { object } JoinContextGroupOptions
7185
- * @property { string } contextGroupId - Id of the context group.
7186
- * @property { Identity | ClientIdentity } [target] - Identity of the entity you wish to join to a context group.
7187
- */
7188
- /**
7189
- * @REMOVED
7190
- * AddClientToContextGroupOptions interface
7191
- * @typedef { object } AddClientToContextGroupOptions@typedef { object } AddClientToContextGroupOptions
7192
- * @property { string } contextGroupId - Name of the context group.
7193
- */
7194
- /**
7195
- * @REMOVED
7196
- * RemoveFromContextGroupOptions interface
7197
- * @typedef { object } RemoveFromContextGroupOptions@typedef { object } RemoveFromContextGroupOptions
7198
- * @property { Identity | ClientIdentity } target - Identity of the entity you wish to join to a context group.
7199
- */
7200
- /**
7201
- * @REMOVED
7202
- * GetInfoForContextGroupOptions interface
7203
- * @typedef { object } GetInfoForContextGroupOptions@typedef { object } GetInfoForContextGroupOptions
7204
- * @property { string } contextGroupId - Name of the context group to get info for.
7205
- */
7206
- /**
7207
- * @REMOVED
7208
- * GetAllClientsInContextGroupOptions interface
7209
- * @typedef { object } GetAllClientsInContextGroupOptions@typedef { object } GetAllClientsInContextGroupOptions
7210
- * @property { string } contextGroupId - Name of the context group to get info for.
7211
- */
7212
- /**
7213
- * @PORTED
7214
- * InfoForIntentOptions interface
7215
- * @typedef { object } InfoForIntentOptions@typedef { object } InfoForIntentOptions
7216
- * @property { string } name Name of the intent to get info for.
7217
- * @property { Context } [context] Optional context.
7218
- */
7219
6907
  /**
7220
6908
  * Sets a context for the context group of the incoming current entity.
7221
6909
  * @param setContextOptions - New context to set.
@@ -7715,95 +7403,6 @@ declare type InteropBrokerOptions = {
7715
7403
  logging?: InteropLoggingOptions;
7716
7404
  };
7717
7405
 
7718
- /**
7719
- * @PORTED
7720
- * @typedef { object } Intent
7721
- * @summary The combination of an action and a context that is passed to an application for resolution.
7722
- * @property { string } name Name of the intent.
7723
- * @property { Context } context Data associated with the intent
7724
- */
7725
- /**
7726
- * @REMOVED
7727
- * @typedef { object } Subscription
7728
- * @summary Object returned when subscribing a handler.
7729
- * @property { function } unsubscribe Function to unsubscribe the handler.
7730
- */
7731
- /**
7732
- * @typedef { function } ContextHandler
7733
- * @summary Subscription function for addContextHandler.
7734
- */
7735
- /**
7736
- * @typedef { function } IntentHandler
7737
- * @summary Subscription function for registerIntentHandler
7738
- */
7739
- /**
7740
- * @PORTED
7741
- * @typedef { object } ClientIdentity
7742
- * @summary The Identity for a Channel Client. Includes endpointId to differentiate between different connections for an entity.
7743
- * @property {string} uuid GUID of an application.
7744
- * @property {string} name Name of an entity in an application.
7745
- * @property {string} endpointId Unique differentiator for different Channel connections for an entity.
7746
- */
7747
- /**
7748
- * @PORTED
7749
- * @typedef { object } ContextGroupInfo
7750
- * @summary Information for a Context Group. Contains metadata for displaying the group properly.
7751
- * @property {string} id Name of the context group
7752
- * @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.
7753
- */
7754
- /**
7755
- * @PORTED
7756
- * @typedef { object } DisplayMetadata
7757
- * @summary The display data for a Context Group.
7758
- * @property {string} name A user-readable name for this context group, e.g: `"Red"`
7759
- * @property {string} [color] The color that should be associated within this context group when displaying this context group in a UI, e.g: `0xFF0000`.
7760
- * @property {string} [glyph] A URL of an image that can be used to display this context group
7761
- */
7762
- /**
7763
- * @PORTED
7764
- * @typedef { object } Context
7765
- * @summary Data passed between entities and applications.
7766
- * @property {object} [id] An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
7767
- * @property {string} [name] User-readable name for the incoming context.
7768
- * @property {string} type Conserved type for the context (e.g. `instrument` or `country`)
7769
- */
7770
- /**
7771
- * @REMOVED
7772
- * @typedef { object } ContextForIntent
7773
- * @summary Data passed between entities and applications, including an optional metadata.
7774
- * @property {object} [id] An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
7775
- * @property {string} [name] User-readable name for the incoming context.
7776
- * @property {string} type Conserved type for the context (e.g. `instrument` or `country`)
7777
- * @property {any} [metadata]
7778
- */
7779
- /**
7780
- * @REMOVED
7781
- * @typedef { object } SessionContextGroup
7782
- * @summary An instance of a SessionContextGroup
7783
- * @property {string} id The SessionContextGroup's id.
7784
- * @property {setContext} setContext Sets a context of a certain type
7785
- * @property {getCurrentContext} getCurrentContext Gets the currently set context of a certain type
7786
- * @property {addContextHandler} addContextHandler Adds a handler for context change.
7787
- */
7788
- /**
7789
- * @typedef {function} setContext
7790
- * @summary A SessionContextGroup instance method for setting a context in the SessionContextGroup.
7791
- * @param context The Context to be set.
7792
- *
7793
- */
7794
- /**
7795
- * @typedef {function} getCurrentContext
7796
- * @summary A SessionContextGroup instance method for getting the current context of a certain type.
7797
- * @param contextType The Context Type to get. If not specified the last contextType set would get used.
7798
- *
7799
- */
7800
- /**
7801
- * @typedef {function} addContextHandler
7802
- * @summary A SessionContextGroup instance method for adding a handler for context change.
7803
- * @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.
7804
- * @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.
7805
- *
7806
- */
7807
7406
  /**
7808
7407
  * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}
7809
7408
  *
@@ -8239,13 +7838,6 @@ declare type InteropLoggingActions = 'beforeAction' | 'afterAction';
8239
7838
  */
8240
7839
  declare type InteropLoggingOptions = Record<InteropLoggingActions, InteropActionLoggingOption>;
8241
7840
 
8242
- /**
8243
- * @PORTED
8244
- * @typedef { object } InteropConfig
8245
- * @summary Information relevant to the Interop Broker.
8246
- * @property {string} [currentContextGroup] Context Group for the client. (green, yellow, red, etc.)
8247
- * @property {string} [providerId] When provided, automatically connects the client to the specified provider uuid
8248
- */
8249
7841
  /**
8250
7842
  * Manages creation of Interop Brokers and Interop Clients. These APIs are called under-the-hood in Platforms.
8251
7843
  *
@@ -13691,83 +13283,6 @@ declare type SubscriptionOptions = {
13691
13283
  declare class System extends EmitterBase<OpenFin.SystemEvent> {
13692
13284
  /* Excluded from this release type: __constructor */
13693
13285
  private sendExternalProcessRequest;
13694
- /**
13695
- * Adds a listener to the end of the listeners array for the specified event.
13696
- * @param eventType - The type of the event.
13697
- * @param listener - Called whenever an event of the specified type occurs.
13698
- * @param options - Option to support event timestamps.
13699
- *
13700
- * @function addListener
13701
- * @memberof System
13702
- * @instance
13703
- * @tutorial System.EventEmitter
13704
- */
13705
- /**
13706
- * Adds a listener to the end of the listeners array for the specified event.
13707
- * @param eventType - The type of the event.
13708
- * @param listener - Called whenever an event of the specified type occurs.
13709
- * @param options - Option to support event timestamps.
13710
- *
13711
- * @function on
13712
- * @memberof System
13713
- * @instance
13714
- * @tutorial System.EventEmitter
13715
- */
13716
- /**
13717
- * 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.
13718
- * @param eventType - The type of the event.
13719
- * @param listener - The callback function.
13720
- * @param options - Option to support event timestamps.
13721
- *
13722
- * @function once
13723
- * @memberof System
13724
- * @instance
13725
- * @tutorial System.EventEmitter
13726
- */
13727
- /**
13728
- * Adds a listener to the beginning of the listeners array for the specified event.
13729
- * @param eventType - The type of the event.
13730
- * @param listener - The callback function.
13731
- * @param options - Option to support event timestamps.
13732
- *
13733
- * @function prependListener
13734
- * @memberof System
13735
- * @instance
13736
- * @tutorial System.EventEmitter
13737
- */
13738
- /**
13739
- * 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.
13740
- * The listener is added to the beginning of the listeners array.
13741
- * @param eventType - The type of the event.
13742
- * @param listener - The callback function.
13743
- * @param options - Option to support event timestamps.
13744
- *
13745
- * @function prependOnceListener
13746
- * @memberof System
13747
- * @instance
13748
- * @tutorial System.EventEmitter
13749
- */
13750
- /**
13751
- * Remove a listener from the listener array for the specified event.
13752
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
13753
- * @param eventType - The type of the event.
13754
- * @param listener - The callback function.
13755
- * @param options - Option to support event timestamps.
13756
- *
13757
- * @function removeListener
13758
- * @memberof System
13759
- * @instance
13760
- * @tutorial System.EventEmitter
13761
- */
13762
- /**
13763
- * Removes all listeners, or those of the specified event.
13764
- * @param eventType - The type of the event.
13765
- *
13766
- * @function removeAllListeners
13767
- * @memberof System
13768
- * @instance
13769
- * @tutorial System.EventEmitter
13770
- */
13771
13286
  /**
13772
13287
  * Returns the version of the runtime. The version contains the major, minor,
13773
13288
  * build and revision numbers.
@@ -15795,169 +15310,6 @@ declare type VerboseWebPermission = {
15795
15310
 
15796
15311
  declare type View = OpenFin.View;
15797
15312
 
15798
- /**
15799
- * @PORTED
15800
- * @typedef {object} View~options
15801
- * @summary View creation options.
15802
- * @desc This is the options object required by {@link View.create View.create}.
15803
- *
15804
- * Note that `name` and `target` are the only required properties — albeit the `url` property is usually provided as well
15805
- * (defaults to `"about:blank"` when omitted).
15806
- *
15807
- * @property {object} [experimental]
15808
- * Configurations for API injection.
15809
- *
15810
- * @property {boolean} [experimental.childWindows] Configure if the runtime should enable child windows for views.
15811
- *
15812
- * @property {object} [accelerator]
15813
- * Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
15814
- *
15815
- * @property {boolean} [accelerator.devtools=false]
15816
- * If `true`, enables the devtools keyboard shortcut:<br>
15817
- * `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
15818
- *
15819
- * @property {boolean} [accelerator.reload=false]
15820
- * If `true`, enables the reload keyboard shortcuts:<br>
15821
- * `Ctrl` + `R` _(Windows)_<br>
15822
- * `F5` _(Windows)_<br>
15823
- * `Command` + `R` _(Mac)_
15824
- *
15825
- * @property {boolean} [accelerator.reloadIgnoringCache=false]
15826
- * If `true`, enables the reload-from-source keyboard shortcuts:<br>
15827
- * `Ctrl` + `Shift` + `R` _(Windows)_<br>
15828
- * `Shift` + `F5` _(Windows)_<br>
15829
- * `Command` + `Shift` + `R` _(Mac)_
15830
- *
15831
- * @property {boolean} [accelerator.zoom=false]
15832
- * If `true`, enables the zoom keyboard shortcuts:<br>
15833
- * `Ctrl` + `+` _(Zoom In)_<br>
15834
- * `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
15835
- * `Ctrl` + `NumPad+` _(Zoom In)_<br>
15836
- * `Ctrl` + `-` _(Zoom Out)_<br>
15837
- * `Ctrl` + `Shift` + `-` _(Zoom Out)_<br>
15838
- * `Ctrl` + `NumPad-` _(Zoom Out)_<br>
15839
- * `Ctrl` + `Scroll` _(Zoom In & Out)_<br>
15840
- * `Ctrl` + `0` _(Restore to 100%)_
15841
- *
15842
- * @property {object} [api]
15843
- * Configurations for API injection.
15844
- *
15845
- * @property {object} [api.iframe] Configure if the the API should be injected into iframes based on domain.
15846
- *
15847
- * @property {boolean} [api.iframe.crossOriginInjection=false] Controls if the `fin` API object is present for cross origin iframes.
15848
- * @property {boolean} [api.iframe.sameOriginInjection=true] Controls if the `fin` API object is present for same origin iframes.
15849
- *
15850
- * @property {string} [autoplayPolicy="no-user-gesture-required"]
15851
- * Autoplay policy to apply to content in the window, can be
15852
- * `no-user-gesture-required`, `user-gesture-required`,
15853
- * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
15854
- *
15855
- * @property {object} [autoResize] AutoResize options
15856
- *
15857
- * @property {object} [bounds] initial bounds given relative to the window.
15858
- *
15859
- * @property {string} [backgroundColor="#FFF"] - _Updatable._
15860
- * The view’s _backfill_ color as a hexadecimal value. Not to be confused with the content background color
15861
- * (`document.body.style.backgroundColor`),
15862
- * this color briefly fills a view’s (a) content area before its content is loaded as well as (b) newly exposed
15863
- * areas when growing a window. Setting
15864
- * this value to the anticipated content background color can help improve user experience.
15865
- * Default is white.
15866
- *
15867
- * @property {object} [contentNavigation]
15868
- * Restrict navigation to URLs that match an allowed pattern.
15869
- * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
15870
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
15871
- * @property {string[]} [contentNavigation.allowlist=[]] List of allowed URLs.
15872
- * @property {string[]} [contentNavigation.denylist=[]] List of denied URLs.
15873
- *
15874
- * @property {object} [contentRedirect]
15875
- * Restrict redirects to URLs that match an allowed pattern.
15876
- * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
15877
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
15878
- * @property {string[]} [contentRedirect.allowlist=[]] List of allowed URLs.
15879
- * @property {string[]} [contentRedirect.denylist=[]] List of denied URLs.
15880
- *
15881
- * @property {object} [contextMenuSettings] - _Updatable._
15882
- * Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
15883
- * Configure the context menu when right-clicking on a view.
15884
- * @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
15885
- * @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
15886
- * @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
15887
- *
15888
- * @property {object} [contextMenuOptions] - _Updatable._
15889
- * Configure the context menu when right-clicking on a view. Supported menu items:
15890
- * 'separator'
15891
- * 'cut'
15892
- * 'copy'
15893
- * 'copyImage',
15894
- * 'paste'
15895
- * 'spellCheck'
15896
- * 'inspect'
15897
- * 'reload'
15898
- * 'navigateForward'
15899
- * 'navigateBack'
15900
- * 'print'
15901
- * @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
15902
- * @property {string[]} [contextMenuOptions.template=[]] List of context menu items to display on right-click.
15903
- *
15904
- * @property {any} [customData=""] - _Updatable._
15905
- * A field that the user can attach serializable data to be ferried around with the view options.
15906
- * _When omitted, the default value of this property is the empty string (`""`)._
15907
- *
15908
- * @property {any} [customContext=""] - _Updatable._
15909
- * A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
15910
- * is called.
15911
- * When omitted, the default value of this property is the empty string (`""`).
15912
- * As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
15913
- *
15914
- * @property {object[]} [hotkeys=[]] - _Updatable._
15915
- * Defines the list of hotkeys that will be emitted as a `hotkey` event on the view. For usage example see [example]{@tutorial hotkeys}.
15916
- * Within Platform, OpenFin also implements a set of pre-defined actions called
15917
- * [keyboard commands]{@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands}
15918
- * that can be assigned to a specific hotkey in the platform manifest.
15919
- * @property {string} hotkeys.keys The key combination of the hotkey, i.e. "Ctrl+T"
15920
- * @property {boolean} [hotkeys.preventDefault=false] preventDefault will prevent the page keydown/keyup events from being emitted.
15921
- *
15922
- * @property {boolean} [isClosable=true] **Platforms Only.** If false, the view will be persistent and can't be closed through
15923
- * either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
15924
- * if the view isn't part of the new layout when running `Layout.replace`.
15925
- *
15926
- * @property {string} name
15927
- * The name of the view.
15928
- *
15929
- * @property {boolean} [detachOnClose=false] - _Updatable._
15930
- * Platforms Only. If true, will hide and detach the View from the window for later use instead of closing,
15931
- * allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
15932
- *
15933
- * @property {string} [manifestUrl] **Platforms Only.** Url to a manifest that contains View Options. Properties other than manifestUrl can still be used
15934
- * but the properties in the manifest will take precedence if there is any collision.
15935
- *
15936
- * @property {preloadScript[]} [preloadScripts] - _Inheritable_
15937
- * A list of scripts that are eval'ed before other scripts in the page. When omitted, _inherits_
15938
- * from the parent application.
15939
- *
15940
- * @property {boolean} [preventDragOut=false] **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
15941
- *
15942
- * @property {string} [processAffinity=<application uuid>]
15943
- * A string to attempt to group renderers together. Will only be used if pages are on the same origin.
15944
- *
15945
- * @property {boolean} [spellCheck=false]
15946
- * Enable spell check in input text fields for the view.
15947
- *
15948
- * @property {Identity} [target]
15949
- * The identity of the window this view should be attached to.
15950
- *
15951
- * @property {string} [url="about:blank"]
15952
- * The URL of the view.
15953
- *
15954
- * @property {string} [uuid=<application uuid>]
15955
- * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
15956
- * If omitted, defaults to the `uuid` of the application spawning the view.
15957
- * If given, must match the `uuid` of the application spawning the view.
15958
- * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
15959
- * really no need to provide it.
15960
- */
15961
15313
  /**
15962
15314
  * A View can be used to embed additional web content into a Window.
15963
15315
  * It is like a child window, except it is positioned relative to its owning window.
@@ -17750,476 +17102,6 @@ declare type WillResizeEvent = WillMoveOrResizeEvent & {
17750
17102
  type: 'will-resize';
17751
17103
  };
17752
17104
 
17753
- /**
17754
- * @PORTED
17755
- * @typedef { object } Margins@typedef { object } Margins
17756
- * @property { string } [marginType]
17757
- * Can be `default`, `none`, `printableArea`, or `custom`. If `custom` is chosen,
17758
- * you will also need to specify `top`, `bottom`, `left`, and `right`.
17759
- *
17760
- * @property { number } [top] The top margin of the printed web page, in pixels.
17761
- * @property { number } [bottom] The bottom margin of the printed web page, in pixels.
17762
- * @property { number } [left] The left margin of the printed web page, in pixels.
17763
- * @property { number } [right] The right margin of the printed web page, in pixels.
17764
- */
17765
- /**
17766
- * @PORTED
17767
- * @typedef { object } Dpi@typedef { object } Dpi
17768
- * @property { number } [horizontal] The horizontal dpi
17769
- * @property { number } [vertical] The vertical dpi
17770
- */
17771
- /**
17772
- * @PORTED
17773
- * @typedef { object } PrintOptions@typedef { object } PrintOptions
17774
- * @property { boolean } [silent=false] Don't ask user for print settings.
17775
- * @property { boolean } [printBackground=false] Prints the background color and image of the web page.
17776
- * @property { string } [deviceName=''] Set the printer device name to use.
17777
- * @property { boolean } [color=true] Set whether the printed web page will be in color or grayscale.
17778
- * @property { Margins } [margins] Set margins for the printed web page
17779
- * @property { boolean } [landscape=false] Whether the web page should be printed in landscape mode.
17780
- * @property { number } [scaleFactor] The scale factor of the web page.
17781
- * @property { number } [pagesPerSheet] The number of pages to print per page sheet.
17782
- * @property { boolean } [collate] Whether the web page should be collated.
17783
- * @property { number } [copies] The number of copies of the web page to print.
17784
- * @property { Record<string, number> } [pageRanges] The page range to print. Should have two keys: from and to.
17785
- * @property { string } [duplexMode] Set the duplex mode of the printed web page. Can be simplex, shortEdge, or longEdge.
17786
- * @property { Dpi } [dpi] Set dpi for the printed web page
17787
- */
17788
- /**
17789
- * @REMOVED
17790
- * PrinterInfo interface
17791
- * @typedef { object } PrinterInfo@typedef { object } PrinterInfo
17792
- * @property { string } name Printer Name
17793
- * @property { string } description Printer Description
17794
- * @property { number } status Printer Status
17795
- * @property { boolean } isDefault Indicates that system's default printer
17796
- */
17797
- /**
17798
- * @REMOVED
17799
- * SharedWorkerInfo interface
17800
- * @typedef { object } SharedWorkerInfo@typedef { object } SharedWorkerInfo
17801
- * @property { string } id The unique id of the shared worker.
17802
- * @property { string } url The url of the shared worker.
17803
- */
17804
- /**
17805
- * @PORTED
17806
- * ContentCreationRule interface
17807
- * @typedef { object } ContentCreationRule@typedef { object } ContentCreationRule
17808
- * @property { string } behavior 'view' | 'window' | 'browser' | 'block'
17809
- * @property { string[] } match List of [match patterns](https://developer.chrome.com/extensions/match_patterns).
17810
- * @property { object } options Window creation options or View creation options.
17811
- */
17812
- /**
17813
- * @PORTED
17814
- * @typedef {object} Window~options
17815
- * @summary Window creation options.
17816
- * @desc This is the options object required by {@link Window.create Window.create}.
17817
- *
17818
- * Note that `name` is the only required property — albeit the `url` property is usually provided as well
17819
- * (defaults to `"about:blank"` when omitted).
17820
- *
17821
- * _This jsdoc typedef mirrors the `WindowOptions` TypeScript interface in `@types/openfin`._
17822
- *
17823
- * @property {object} [accelerator]
17824
- * Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
17825
- *
17826
- * @property {boolean} [accelerator.devtools=false]
17827
- * If `true`, enables the devtools keyboard shortcut:<br>
17828
- * `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
17829
- *
17830
- * @property {boolean} [accelerator.reload=false]
17831
- * If `true`, enables the reload keyboard shortcuts:<br>
17832
- * `Ctrl` + `R` _(Windows)_<br>
17833
- * `F5` _(Windows)_<br>
17834
- * `Command` + `R` _(Mac)_
17835
- *
17836
- * @property {boolean} [accelerator.reloadIgnoringCache=false]
17837
- * If `true`, enables the reload-from-source keyboard shortcuts:<br>
17838
- * `Ctrl` + `Shift` + `R` _(Windows)_<br>
17839
- * `Shift` + `F5` _(Windows)_<br>
17840
- * `Command` + `Shift` + `R` _(Mac)_
17841
- *
17842
- * @property {boolean} [accelerator.zoom=false]
17843
- * 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.
17844
- * If `true`, enables the zoom keyboard shortcuts:<br>
17845
- * `Ctrl` + `+` _(Zoom In)_<br>
17846
- * `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
17847
- * `Ctrl` + `NumPad+` _(Zoom In)_<br>
17848
- * `Ctrl` + `-` _(Zoom Out)_<br>
17849
- * `Ctrl` + `Shift` + `-` _(Zoom Out)_<br>
17850
- * `Ctrl` + `NumPad-` _(Zoom Out)_<br>
17851
- * `Ctrl` + `Scroll` _(Zoom In & Out)_<br>
17852
- * `Ctrl` + `0` _(Restore to 100%)_
17853
- *
17854
- * @property {object} [alphaMask] - _Experimental._ _Updatable._
17855
- * <br>
17856
- * alphaMask turns anything of matching RGB value transparent.
17857
- * <br>
17858
- * Caveats:
17859
- * * Runtime flags --disable-gpu and --allow-unsafe-compositing are required. Note: Unclear behavior on remote Desktop support
17860
- * * User cannot click-through transparent regions
17861
- * * Not supported on Mac
17862
- * * Windows Aero must be enabled
17863
- * * Won't make visual sense on Pixel-pushed environments such as Citrix
17864
- * * Not supported on rounded corner windows
17865
- * @property {number} [alphaMask.red=-1] 0-255
17866
- * @property {number} [alphaMask.green=-1] 0-255
17867
- * @property {number} [alphaMask.blue=-1] 0-255
17868
- *
17869
- * @property {boolean} [alwaysOnTop=false] - _Updatable._
17870
- * A flag to always position the window at the top of the window stack.
17871
- *
17872
- * @property {object} [api]
17873
- * Configurations for API injection.
17874
- *
17875
- * @property {object} [api.iframe] Configure if the the API should be injected into iframes based on domain.
17876
- *
17877
- * @property {boolean} [api.iframe.crossOriginInjection=false] Controls if the `fin` API object is present for cross origin iframes.
17878
- * @property {boolean} [api.iframe.sameOriginInjection=true] Controls if the `fin` API object is present for same origin iframes.
17879
- *
17880
- * @property {string} [applicationIcon = ""] - _Deprecated_ - use `icon` instead.
17881
- *
17882
- * @property {number} [aspectRatio=0] - _Updatable._
17883
- * The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
17884
- * an aspect ratio will not be enforced.
17885
- *
17886
- * @property {string} [autoplayPolicy="no-user-gesture-required"]
17887
- * Autoplay policy to apply to content in the window, can be
17888
- * `no-user-gesture-required`, `user-gesture-required`,
17889
- * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
17890
- *
17891
- * @property {boolean} [autoShow=true]
17892
- * A flag to automatically show the window when it is created.
17893
- *
17894
- * @property {string} [backgroundColor="#FFF"]
17895
- * The window’s _backfill_ color as a hexadecimal value. Not to be confused with the content background color
17896
- * (`document.body.style.backgroundColor`),
17897
- * this color briefly fills a window’s (a) content area before its content is loaded as well as (b) newly exposed
17898
- * areas when growing a window. Setting
17899
- * this value to the anticipated content background color can help improve user experience.
17900
- * Default is white.
17901
- *
17902
- * @property {object} [contentCreation]
17903
- * Apply rules that determine how user interaction (`window.open` and links) creates content.
17904
- * @property {ContentCreationRule[]} [contentCreation.rules = []] List of content creation rules.
17905
- *
17906
- * @property {object} [contentNavigation]
17907
- * Restrict navigation to URLs that match an allowed pattern.
17908
- * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
17909
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
17910
- * @property {string[]} [contentNavigation.allowlist=[]] List of allowed URLs.
17911
- * @property {string[]} [contentNavigation.denylist=[]] List of denied URLs.
17912
- *
17913
- * @property {object} [contentRedirect]
17914
- * Restrict redirects to URLs that match an allowed pattern.
17915
- * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
17916
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
17917
- * @property {string[]} [contentRedirect.allowlist=[]] List of allowed URLs.
17918
- * @property {string[]} [contentRedirect.denylist=[]] List of denied URLs.
17919
- *
17920
- * @property {boolean} [contextMenu=true] - _Updatable._
17921
- * A flag to show the context menu when right-clicking on a window.
17922
- * Gives access to the devtools for the window.
17923
- *
17924
- * @property {object} [contextMenuSettings] - _Updatable._
17925
- * Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
17926
- * Configure the context menu when right-clicking on a window.
17927
- * @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
17928
- * @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
17929
- * @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
17930
- *
17931
- * @property {object} [contextMenuOptions] - _Updatable._
17932
- * Configure the context menu when right-clicking on a window. Supported menu items:
17933
- * 'separator'
17934
- * 'cut'
17935
- * 'copy'
17936
- * 'paste'
17937
- * 'spellCheck'
17938
- * 'inspect'
17939
- * 'reload'
17940
- * 'navigateForward'
17941
- * 'navigateBack'
17942
- * 'print'
17943
- * @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
17944
- * @property {string[]} [contextMenuSettings.template=[]] List of context menu items to display on right-click.
17945
- *
17946
- * @property {object} [cornerRounding] - _Updatable._
17947
- * Defines and applies rounded corners for a frameless window. **NOTE:** On macOS corner is not ellipse but circle rounded by the
17948
- * average of _height_ and _width_.
17949
- * @property {number} [cornerRounding.height=0] The height in pixels.
17950
- * @property {number} [cornerRounding.width=0] The width in pixels.
17951
- *
17952
- * @property {any} [customContext=""] - _Updatable. Inheritable._
17953
- * A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
17954
- * is called. If a window in a Platform is trying to update or retrieve its own context, it can use the
17955
- * {@link Platform#setWindowContext Platform.setWindowContext} and {@link Platform#getWindowContext Platform.getWindowContext} calls.
17956
- * _When omitted, _inherits_ from the parent application._
17957
- * As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
17958
- *
17959
- * @property {any} [customData=""] - _Updatable. Inheritable._
17960
- * A field that the user can attach serializable data to be ferried around with the window options.
17961
- * _When omitted, _inherits_ from the parent application._
17962
- *
17963
- * @property {object[]} [customRequestHeaders]
17964
- * Defines list of custom headers for requests sent by the window.
17965
- * @property {string[]} [customRequestHeaders.urlPatterns=[]] The URL patterns for which the headers will be applied
17966
- * @property {object[]} [customRequestHeaders.headers=[]] Objects representing headers and their values,
17967
- * where the object key is the name of header and value at key is the value of the header
17968
- *
17969
- * @property {boolean} [closeOnLastViewRemoved=true] - _Experimental._ _Updatable._
17970
- * Toggling off would keep the Window alive even if all its Views were closed.
17971
- * This is meant for advanced users and should be used with caution.
17972
- * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
17973
- * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
17974
- * ** note ** - This option is ignored in non-Platforms apps.
17975
- *
17976
- * @property {boolean} [defaultCentered=false]
17977
- * Centers the window in the primary monitor. This option overrides `defaultLeft` and `defaultTop`. When `saveWindowState` is `true`,
17978
- * this value will be ignored for subsequent launches in favor of the cached value. **NOTE:** On macOS _defaultCenter_ is
17979
- * somewhat above center vertically.
17980
- *
17981
- * @property {number} [defaultHeight=500]
17982
- * The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
17983
- * in favor of the cached value.
17984
- *
17985
- * @property {number} [defaultLeft=100]
17986
- * The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
17987
- * launches in favor of the cached value.
17988
- *
17989
- * @property {number} [defaultTop=100]
17990
- * The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
17991
- * launches in favor of the cached value.
17992
- *
17993
- * @property {number} [defaultWidth=800]
17994
- * The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
17995
- * launches in favor of the cached value.
17996
- *
17997
- * @property {boolean} [includeInSnapshots=true] - _Updatable._
17998
- * When true, the window will be be included in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
17999
- * inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
18000
- *
18001
- * @property {boolean} [frame=true] - _Updatable._
18002
- * A flag to show the frame.
18003
- *
18004
- * @hidden-property {boolean} [hideOnClose=false] - A flag to allow a window to be hidden when the close button is clicked.
18005
- *
18006
- * @property {object[]} [hotkeys=[]] - _Updatable._
18007
- * Defines the list of hotkeys that will be emitted as a `hotkey` event on the window. For usage example see [example]{@tutorial hotkeys}.
18008
- * Within Platform, OpenFin also implements a set of pre-defined actions called
18009
- * [keyboard commands]{@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands}
18010
- * that can be assigned to a specific hotkey in the platform manifest.
18011
- * @property {string} hotkeys.keys The key combination of the hotkey, i.e. "Ctrl+T"
18012
- * @property {boolean} [hotkeys.preventDefault=false] Whether or not to prevent default key handling before emitting the event
18013
- *
18014
- * @property {string} [icon] - _Updatable. Inheritable._
18015
- * A URL for the icon to be shown in the window title bar and the taskbar.
18016
- * When omitted, inherits from the parent application._
18017
- * note: Window OS caches taskbar icons, therefore an icon change might only be visible after the cache is removed or the uuid is changed.
18018
- *
18019
- * @property {number} [maxHeight=-1] - _Updatable._
18020
- * The maximum height of a window. Will default to the OS defined value if set to -1.
18021
- *
18022
- * @property {boolean} [maximizable=true] - _Updatable._
18023
- * A flag that lets the window be maximized.
18024
- *
18025
- * @property {number} [maxWidth=-1] - _Updatable._
18026
- * The maximum width of a window. Will default to the OS defined value if set to -1.
18027
- *
18028
- * @property {number} [minHeight=0] - _Updatable._
18029
- * The minimum height of a window.
18030
- *
18031
- * @property {boolean} [minimizable=true] - _Updatable._
18032
- * A flag that lets the window be minimized.
18033
- *
18034
- * @property {number} [minWidth=0] - _Updatable._
18035
- * The minimum width of a window.
18036
- *
18037
- * @property {Identity} [modalParentIdentity]
18038
- * Parent identity of a modal window. It will create a modal child window when this option is set.
18039
- *
18040
- * @property {string} name
18041
- * The name of the window.
18042
- *
18043
- * @property {number} [opacity=1.0] - _Updatable._
18044
- * A flag that specifies how transparent the window will be.
18045
- * Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
18046
- * This value is clamped between `0.0` and `1.0`.
18047
- * * In software composition mode, the runtime flag --allow-unsafe-compositing is required.
18048
- *
18049
- * @property {preloadScript[]} [preloadScripts] - _Inheritable_
18050
- * A list of scripts that are eval'ed before other scripts in the page. When omitted, _inherits_
18051
- * from the parent application.
18052
- *
18053
- * @property {string} [processAffinity]
18054
- * A string to attempt to group renderers together. Will only be used if pages are on the same origin.
18055
- *
18056
- * @property {boolean} [resizable=true] - _Updatable._
18057
- * A flag to allow the user to resize the window.
18058
- *
18059
- * @property {object} [resizeRegion] - _Updatable._
18060
- * Defines a region in pixels that will respond to user mouse interaction for resizing a frameless window.
18061
- * @property {number} [resizeRegion.bottomRightCorner=9]
18062
- * The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
18063
- * @property {number} [resizeRegion.size=7]
18064
- * The size in pixels.
18065
- * @property {object} [resizeRegion.sides={top:true,right:true,bottom:true,left:true}]
18066
- * Sides that a window can be resized from.
18067
- *
18068
- * @property {boolean} [saveWindowState=true]
18069
- * A flag to cache the location of the window.
18070
- * ** note ** - This option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
18071
- *
18072
- * @property {boolean} [ignoreSavedWindowState]
18073
- * A flag to ignore previously cached state of the window. It defaults the opposite value of `saveWindowState` to maintain backwards compatibility.
18074
- *
18075
- * @property {boolean} [shadow=false]
18076
- * A flag to display a shadow on frameless windows.
18077
- * `shadow` and `cornerRounding` are mutually exclusive.
18078
- * On Windows 7, Aero theme is required.
18079
- *
18080
- * @property {boolean} [showBackgroundImages=false] - _Updatable._
18081
- * Platforms Only. If true, will show background images in the layout when the Views are hidden.
18082
- * This occurs when the window is resizing or a tab is being dragged within the layout.
18083
- *
18084
- * @property {boolean} [showTaskbarIcon=true] - _Updatable._ _Windows_.
18085
- * A flag to show the window's icon in the taskbar.
18086
- *
18087
- * @property {boolean} [smallWindow=false]
18088
- * A flag to specify a frameless window that can be be created and resized to less than 41x36 px (width x height).
18089
- * _Note: Caveats of small windows are no Aero Snap and drag to/from maximize._
18090
- * _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
18091
- *
18092
- * @property {boolean} [spellCheck=false]
18093
- * Enable spell check in input text fields for the window.
18094
- *
18095
- * @property {string} [state="normal"]
18096
- * The visible state of the window on creation.
18097
- * One of:
18098
- * * `"maximized"`
18099
- * * `"minimized"`
18100
- * * `"normal"`
18101
- *
18102
- * @property {string} [taskbarIcon=string] - Deprecated - use `icon` instead._Windows_.
18103
- *
18104
- * @property {string} [taskbarIconGroup=<application uuid>] - _Windows_.
18105
- * Specify a taskbar group for the window.
18106
- * _If omitted, defaults to app's uuid (`fin.Application.getCurrentSync().identity.uuid`)._
18107
- *
18108
- * @property {string} [url="about:blank"]
18109
- * The URL of the window.
18110
- *
18111
- * @property {string} [uuid=<application uuid>]
18112
- * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
18113
- * If omitted, defaults to the `uuid` of the application spawning the window.
18114
- * If given, must match the `uuid` of the application spawning the window.
18115
- * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
18116
- * really no need to provide it.
18117
- *
18118
- * @property {boolean} [waitForPageLoad=false]
18119
- * When set to `true`, the window will not appear until the `window` object's `load` event fires.
18120
- * When set to `false`, the window will appear immediately without waiting for content to be loaded.
18121
- *
18122
- * @property {ViewVisibility} [viewVisibility]
18123
- * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
18124
- */
18125
- /**
18126
- * @PORTED
18127
- * @typedef {Object} ViewVisibility@typedef {Object} ViewVisibility _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
18128
- * @property {ShowViewsOnWindowResize} [showViewsOnWindowResize] Enables views to be shown when a Platform Window is being resized by the user.
18129
- * @property {ShowViewsOnSplitterDrag} [showViewsOnSplitterDrag] Allows views to be shown when they are resized by the user dragging the splitter between layout stacks.
18130
- * @property {ShowViewsOnTabDrag} [showViewsOnTabDrag] _Supported on Windows Operating Systems only_. Allows views to be shown when the user is dragging a tab around a layout.
18131
- */
18132
- /**
18133
- * @PORTED
18134
- * @typedef {Object} ShowViewsOnWindowResize@typedef {Object} ShowViewsOnWindowResize _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
18135
- * @property {boolean} [enabled=false] Enables or disables showing Views when a Platform Window is being resized.
18136
- * @property {number} [paintIntervalMs=0] Number of miliseconds to wait between view repaints.
18137
- */
18138
- /**
18139
- * @REMOVED
18140
- * @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.
18141
- * @property {boolean} [enabled=false] Enables or disables showing views when the layout splitter is being dragged.
18142
- */
18143
- /**
18144
- * @REMOVED
18145
- * @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.
18146
- * @property {boolean} [enabled=false] Enables or disables showing views when a tab is being dragged.
18147
- */
18148
- /**
18149
- * @PORTED
18150
- * @typedef {object} CapturePageOptions@typedef {object} CapturePageOptions
18151
- * @property { Area } [area] The area of the window to be captured.
18152
- * @property { string } [format='png'] The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
18153
- * @property { number } [quality=100] Number representing quality of JPEG image only. Between 0 - 100.
18154
- */
18155
- /**
18156
- * @PORTED
18157
- * @typedef { object } Area@typedef { object } Area
18158
- * @property { number } height Area's height
18159
- * @property { number } width Area's width
18160
- * @property { number } x X coordinate of area's starting point
18161
- * @property { number } y Y coordinate of area's starting point
18162
- */
18163
- /**
18164
- * @PORTED
18165
- * @typedef {object} FindInPageOptions@typedef {object} FindInPageOptions
18166
- * @property {boolean} [forward=true] Whether to search forward or backward.
18167
- * @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.
18168
- * @property {boolean} [matchCase=false] Whether search should be case-sensitive.
18169
- * @property {boolean} [wordStart=false] Whether to look only at the start of words.
18170
- * @property {boolean} [medialCapitalAsWordStart=false]
18171
- * 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>
18172
- * lowercase or non-letter. Accepts several other intra-word matches.
18173
- */
18174
- /**
18175
- * @REMOVED
18176
- * @typedef {object} Transition@typedef {object} Transition
18177
- * @property {Opacity} opacity - The Opacity transition
18178
- * @property {Position} position - The Position transition
18179
- * @property {Size} size - The Size transition
18180
- */
18181
- /**
18182
- * @PORTED
18183
- * @typedef {object} TransitionOptions@typedef {object} TransitionOptions
18184
- * @property {boolean} interrupt - This option interrupts the current animation. When false it pushes
18185
- this animation onto the end of the animation queue.
18186
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
18187
- */
18188
- /**
18189
- * @PORTED
18190
- * @typedef {object} Size@typedef {object} Size
18191
- * @property {number} duration - The total time in milliseconds this transition should take.
18192
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
18193
- * @property {number} width - Optional if height is present. Defaults to the window's current width.
18194
- * @property {number} height - Optional if width is present. Defaults to the window's current height.
18195
- */
18196
- /**
18197
- * @PORTED
18198
- * @typedef {object} Position@typedef {object} Position
18199
- * @property {number} duration - The total time in milliseconds this transition should take.
18200
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
18201
- * @property {number} left - Defaults to the window's current left position in virtual screen coordinates.
18202
- * @property {number} top - Defaults to the window's current top position in virtual screen coordinates.
18203
- */
18204
- /**
18205
- * @PORTED
18206
- * @typedef {object} Opacity@typedef {object} Opacity
18207
- * @property {number} duration - The total time in milliseconds this transition should take.
18208
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
18209
- * @property {number} opacity - This value is clamped from 0.0 to 1.0.
18210
- */
18211
- /**
18212
- * @REMOVED
18213
- * Bounds is a interface that has the properties of height,
18214
- * width, left, top which are all numbers
18215
- * @typedef { object } Bounds@typedef { object } Bounds
18216
- * @property { number } height Get the application height bound
18217
- * @property { number } width Get the application width bound
18218
- * @property { number } top Get the application top bound
18219
- * @property { number } left Get the application left bound
18220
- * @property { number } right Get the application right bound
18221
- * @property { number } bottom Get the application bottom bound
18222
- */
18223
17105
  /**
18224
17106
  * A basic window that wraps a native HTML window. Provides more fine-grained
18225
17107
  * control over the window state such as the ability to minimize, maximize, restore, etc.
@@ -19070,28 +17952,6 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
19070
17952
  * ```
19071
17953
  */
19072
17954
  authenticate(userName: string, password: string): Promise<void>;
19073
- /**
19074
- * @typedef {object} ShowPopupMenuOptions@typedef {object} ShowPopupMenuOptions
19075
- * @property {Array<MenuItemTemplate>} template - An array describing the menu to show.
19076
- * @property {number} [x] - The window x coordinate where to show the menu. Defaults to mouse position. If using must also use `y`.
19077
- * @property {number} [y] - The window y coordinate where to show the menu. Defaults to mouse position. If using must also use `x`
19078
- */
19079
- /**
19080
- * @typedef {object} MenuItemTemplate@typedef {object} MenuItemTemplate
19081
- * @property {*} data - Data to be returned if the user selects the element. Must be serializable. Large objects can have a performance impact.
19082
- * @property {'normal' | 'separator' | 'submenu' | 'checkbox'} [type] - Defaults to 'normal' unless a 'submenu' key exists
19083
- * @property {string} [label] - The text to show on the menu item. Should be left undefined for `type: 'separator'`
19084
- * @property {boolean} [enabled] - If false, the menu item will be greyed out and unclickable.
19085
- * @property {boolean} [visible] - If false, the menu item will be entirely hidden.
19086
- * @property {boolean} [checked] - Should only be specified for `checkbox` type menu items.
19087
- * @property {string} [icon] - Image Data URI with image dimensions inferred from the encoded string
19088
- * @property {Array<MenuItemTemplate>} [submenu] Should be specified for `submenu` type menu items. If `submenu` is specified, the `type: 'submenu'` can be omitted.
19089
- */
19090
- /**
19091
- * @typedef {object} MenuResult@typedef {object} MenuResult
19092
- * @property {'clicked' | 'closed'} result - Whether the user clicked on a menu item or the menu was closed (user clicked elsewhere).
19093
- * @property {* | undefined} [data] - The data property of the menu item clicked by the user. Only defined if result was `clicked`.
19094
- */
19095
17955
  /**
19096
17956
  * Shows a menu on the window.
19097
17957
  *
@@ -19188,577 +18048,552 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
19188
18048
  */
19189
18049
  closePopupMenu(): Promise<void>;
19190
18050
  /**
19191
- * @PORTED
19192
- * @typedef {object} PopupOptions@typedef {object} PopupOptions
19193
- * @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.
19194
- * @property {string} [url] - Navigates to this `url` if showing an existing window as a popup, otherwise the newly created window will load this `url`.
19195
- * @property {Window~options} [initialOptions] - Window creation options when using `showPopupWindow` to create a new window.
19196
- * @property {Window~options} [additionalOptions] - Updatable window options applied to new and existing windows when shown as popups.
19197
- * @property {function} [onPopupResult] - Executed when this window's popup calls `dispatchPopupResult`. Note: if this is defined, `showPopupWindow` will not return a `PopupResult`.
19198
- * @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.
19199
- * @property {number} [height] - Height of the popup window (takes priority over `intialOptions` size properties).
19200
- * @property {number} [width] - Width of the popup window (takes priority over `intialOptions` size properties).
19201
- * @property {number} [x] - Left position where the popup window will be shown (relative to the window calling `showPopupWindow`).
19202
- * @property {number} [y] - Top position where the popup window will be shown (relative to the window calling `showPopupWindow`).
19203
- * @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.
19204
- * @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`.
19205
- * @property {boolean} [focus] - Determines if the popup window should or should not be focused when it is shown.
19206
- * @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.
19207
- */
19208
- /**
19209
- * @PORTED
19210
- * @typedef {object} PopupResult@typedef {object} PopupResult
19211
- * @property {Identity} identity - `name` and `uuid` of the popup window that called dispatched this result.
19212
- * @property {'clicked' | 'dismissed'} result - Result of the user interaction with the popup window.
19213
- * @property {* | undefined} [data] - Data passed to `dispatchPopupResult`.
19214
- */
19215
- /**
19216
- * Dispatch a result to the caller of `showPopupWindow`.
19217
- *
19218
- * @remarks If this window isn't currently being shown as a popup, this call will silently fail.
19219
- * @param data Serializable data to send to the caller window.
19220
- *
19221
- * @example
19222
- * ```js
19223
- * await fin.me.dispatchPopupResult({
19224
- * foo: 'bar'
19225
- * });
19226
- * ```
19227
- */
19228
- dispatchPopupResult(data: any): Promise<void>;
19229
- /**
19230
- * Prints the contents of the window.
19231
- *
19232
- * @param options Configuration for the print task.
19233
- * @remarks When `silent` is set to `true`, the API will pick the system's default printer if deviceName is empty
19234
- * and the default settings for printing.
19235
- *
19236
- * Use the CSS style `page-break-before: always;` to force print to a new page.
19237
- *
19238
- * @example
19239
- * ```js
19240
- * const win = fin.Window.getCurrentSync();
19241
- *
19242
- * win.print({ silent: false, deviceName: 'system-printer-name' }).then(() => {
19243
- * console.log('print call has been sent to the system');
19244
- * });
19245
- * ```
19246
- *
19247
- * If a window has embedded views, those views will not print by default. To print a window's contents including embedded views,
19248
- * use the `content` option:
19249
- *
19250
- * ```js
19251
- * const win = fin.Window.getCurrentSync();
19252
- *
19253
- * // Print embedded views
19254
- * win.print({ content: 'views' });
19255
- *
19256
- * // Print screenshot of current window
19257
- * win.print({ content: 'screenshot' })
19258
- * ```
19259
- *
19260
- * When `content` is set to `views`, the embedded views in the platform window will be concatenated and printed as
19261
- * individual pages. If `includeSelf` is set to `true`, the platform window itself will be printed as the first
19262
- * page - be aware that this page will *not* include the embedded views - it will only include the contents of
19263
- * the platform window itself (e.g. tab stacks), with blank spaces where the view contents would be embedded.
19264
- *
19265
- * Due to a known issue, view contents that are not visible at the time `print` is called will not appear when
19266
- * printing `contents: views`. This includes views that are obscured behind other active UI elements.
19267
- *
19268
- * To print the views embedded in their page context, set `content` to `screenshot`.
19269
- */
19270
- print(options?: OpenFin.WindowPrintOptions): Promise<void>;
19271
- }
19272
-
19273
- /**
19274
- * Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
19275
- * @interface
19276
- */
19277
- declare type WindowAlertRequestedEvent = BaseEvent_3 & {
19278
- type: 'window-alert-requested';
19279
- };
19280
-
19281
- /**
19282
- * Returned from getBounds call. bottom and right are never used for setting.
19283
- * @interface
19284
- */
19285
- declare type WindowBounds = Bounds & {
19286
- bottom: number;
19287
- right: number;
19288
- };
19289
-
19290
- /**
19291
- * @deprecated Renamed to {@link ClosedEvent}.
19292
- */
19293
- declare type WindowClosedEvent = ClosedEvent_2;
19294
-
19295
- /**
19296
- * @deprecated Renamed to {@link CloseRequestedEvent}.
19297
- */
19298
- declare type WindowCloseRequestedEvent = CloseRequestedEvent;
19299
-
19300
- /**
19301
- * @deprecated Renamed to {@link ClosingEvent}.
19302
- */
19303
- declare type WindowClosingEvent = ClosingEvent;
19304
-
19305
- /**
19306
- * A rule prescribing content creation in a {@link OpenFin.Window}.
19307
- *
19308
- * @interface
19309
- */
19310
- declare type WindowContentCreationRule = BaseContentCreationRule & {
19311
- /**
19312
- * Behavior to use when opening matched content.
19313
- */
19314
- behavior: 'window';
19315
- /**
19316
- * Options for newly-created window.
19317
- */
19318
- options?: Partial<WindowOptions>;
19319
- };
19320
-
19321
- /**
19322
- * Generated when a child window is created.
19323
- * @interface
19324
- */
19325
- declare type WindowCreatedEvent = BaseEvent_3 & {
19326
- type: 'window-created';
19327
- };
19328
-
19329
- /**
19330
- * Options required to create a new window with {@link Window._WindowModule.create Window.create}.
19331
- *
19332
- * Note that `name` is the only required property — albeit the `url` property is usually provided as well
19333
- * (defaults to `"about:blank"` when omitted).
19334
- * @interface
19335
- */
19336
- declare type WindowCreationOptions = Partial<WindowOptions> & {
19337
- name: string;
19338
- };
19339
-
19340
- declare type WindowCreationReason = 'tearout' | 'create-view-without-target' | 'api-call' | 'app-creation' | 'restore' | 'apply-snapshot';
19341
-
19342
- /**
19343
- * @interface
19344
- */
19345
- declare type WindowDetail = {
19346
- /**
19347
- * The bottom-most coordinate of the window.
19348
- */
19349
- bottom: number;
19350
- /**
19351
- * The height of the window.
19352
- */
19353
- height: number;
19354
- isShowing: boolean;
19355
- /**
19356
- * The left-most coordinate of the window.
19357
- */
19358
- left: number;
19359
- /**
19360
- * The name of the window.
19361
- */
19362
- name: string;
19363
- /**
19364
- * The right-most coordinate of the window.
19365
- */
19366
- right: number;
19367
- state: string;
19368
- /**
19369
- * The top-most coordinate of the window.
19370
- */
19371
- top: number;
19372
- /**
19373
- * The width of the window.
19374
- */
19375
- width: number;
19376
- };
19377
-
19378
- /**
19379
- * Generated when a child window ends loading.
19380
- * @interface
19381
- */
19382
- declare type WindowEndLoadEvent = BaseEvent_3 & {
19383
- type: 'window-end-load';
19384
- };
19385
-
19386
- /**
19387
- * @deprecated, Renamed to {@link Event}.
19388
- */
19389
- declare type WindowEvent = Event_6;
19390
-
19391
- declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
19392
-
19393
- declare namespace WindowEvents {
19394
- export {
19395
- BaseEvent_5 as BaseEvent,
19396
- BaseWindowEvent,
19397
- ViewAttachedEvent,
19398
- ViewDetachedEvent,
19399
- WindowViewEvent,
19400
- AlertRequestedEvent,
19401
- AuthRequestedEvent,
19402
- EndLoadEvent,
19403
- WillRedirectEvent,
19404
- ReloadedEvent,
19405
- OptionsChangedEvent,
19406
- WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
19407
- ExternalProcessExitedEvent,
19408
- ExternalProcessStartedEvent,
19409
- HiddenEvent_2 as HiddenEvent,
19410
- WindowHiddenEvent,
19411
- PreloadScriptInfoRunning,
19412
- PreloadScriptInfo,
19413
- PreloadScriptsStateChangeEvent,
19414
- UserBoundsChangeEvent,
19415
- BoundsChangeEvent,
19416
- WillMoveOrResizeEvent,
19417
- PerformanceReportEvent,
19418
- InputEvent_2 as InputEvent,
19419
- LayoutInitializedEvent,
19420
- LayoutReadyEvent,
19421
- BeginUserBoundsChangingEvent,
19422
- BoundsChangedEvent,
19423
- BoundsChangingEvent,
19424
- CloseRequestedEvent,
19425
- WindowCloseRequestedEvent,
19426
- ContextChangedEvent,
19427
- ClosedEvent_2 as ClosedEvent,
19428
- WindowClosedEvent,
19429
- ClosingEvent,
19430
- WindowClosingEvent,
19431
- DisabledMovementBoundsChangedEvent,
19432
- DisabledMovementBoundsChangingEvent,
19433
- EmbeddedEvent,
19434
- EndUserBoundsChangingEvent,
19435
- HotkeyEvent_2 as HotkeyEvent,
19436
- WindowHotkeyEvent,
19437
- InitializedEvent_2 as InitializedEvent,
19438
- WindowInitializedEvent,
19439
- MaximizedEvent,
19440
- MinimizedEvent,
19441
- PreloadScriptsStateChangedEvent,
19442
- PreloadScriptsStateChangingEvent,
19443
- RestoredEvent,
19444
- WindowRestoredEvent,
19445
- ShowRequestedEvent,
19446
- WindowShowRequestedEvent,
19447
- ShownEvent_2 as ShownEvent,
19448
- WindowShownEvent,
19449
- UserMovementEnabledEvent,
19450
- UserMovementDisabledEvent,
19451
- WillMoveEvent,
19452
- WillResizeEvent,
19453
- NonPropagatedWindowEvent,
19454
- ShowAllDownloadsEvent,
19455
- DownloadShelfVisibilityChangedEvent,
19456
- WindowSourcedEvent,
19457
- WillPropagateWindowEvent,
19458
- Event_6 as Event,
19459
- WindowEvent,
19460
- EventType_2 as EventType,
19461
- WindowEventType,
19462
- PropagatedEvent_3 as PropagatedEvent,
19463
- PropagatedWindowEvent,
19464
- PropagatedWindowEventType,
19465
- Payload_3 as Payload,
19466
- ByType_2 as ByType
19467
- }
19468
- }
19469
-
19470
- /**
19471
- * @deprecated Renamed to {@link EventType}.
19472
- */
19473
- declare type WindowEventType = WindowEvent['type'];
19474
-
19475
- /**
19476
- * @deprecated Renamed to {@link HiddenEvent}.
19477
- */
19478
- declare type WindowHiddenEvent = HiddenEvent_2;
19479
-
19480
- /**
19481
- * @deprecated Renamed to {@link HotkeyEvent}.
19482
- */
19483
- declare type WindowHotkeyEvent = HotkeyEvent_2;
19484
-
19485
- /**
19486
- * @interface
19487
- */
19488
- declare type WindowInfo = {
19489
- canNavigateBack: boolean;
19490
- canNavigateForward: boolean;
19491
- preloadScripts: Array<any>;
19492
- title: string;
19493
- url: string;
19494
- };
19495
-
19496
- /**
19497
- * @deprecated Renamed to {@link InitializedEvent}.
19498
- */
19499
- declare type WindowInitializedEvent = InitializedEvent_2;
19500
-
19501
- /**
19502
- * Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
19503
- */
19504
- declare class _WindowModule extends Base {
19505
- /**
19506
- * Asynchronously returns a Window object that represents an existing window.
19507
- *
19508
- * @example
19509
- * ```js
19510
- * async function createWin() {
19511
- * const app = await fin.Application.start({
19512
- * name: 'myApp',
19513
- * uuid: 'app-1',
19514
- * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrap.html',
19515
- * autoShow: true
19516
- * });
19517
- * return await app.getWindow();
19518
- * }
19519
- * createWin().then(() => fin.Window.wrap({ uuid: 'app-1', name: 'myApp' }))
19520
- * .then(win => console.log('wrapped window'))
19521
- * .catch(err => console.log(err));
19522
- * ```
19523
- */
19524
- wrap(identity: OpenFin.Identity): Promise<OpenFin.Window>;
19525
- /**
19526
- * Synchronously returns a Window object that represents an existing window.
19527
- *
19528
- * @example
19529
- * ```js
19530
- * async function createWin() {
19531
- * const app = await fin.Application.start({
19532
- * name: 'myApp',
19533
- * uuid: 'app-1',
19534
- * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrapSync.html',
19535
- * autoShow: true
19536
- * });
19537
- * return await app.getWindow();
19538
- * }
19539
- * await createWin();
19540
- * let win = fin.Window.wrapSync({ uuid: 'app-1', name: 'myApp' });
19541
- * ```
19542
- */
19543
- wrapSync(identity: OpenFin.Identity): OpenFin.Window;
19544
- /**
19545
- * Creates a new Window.
19546
- * @param options - Window creation options
19547
- *
19548
- * @example
19549
- * ```js
19550
- * async function createWindow() {
19551
- * const winOption = {
19552
- * name:'child',
19553
- * defaultWidth: 300,
19554
- * defaultHeight: 300,
19555
- * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.create.html',
19556
- * frame: true,
19557
- * autoShow: true
19558
- * };
19559
- * return await fin.Window.create(winOption);
19560
- * }
19561
- *
19562
- * createWindow().then(() => console.log('Window is created')).catch(err => console.log(err));
19563
- * ```
19564
- */
19565
- create(options: OpenFin.WindowCreationOptions): Promise<OpenFin.Window>;
19566
- /**
19567
- * Asynchronously returns a Window object that represents the current window
19568
- *
19569
- * @example
19570
- * ```js
19571
- * fin.Window.getCurrent()
19572
- * .then(wnd => console.log('current window'))
19573
- * .catch(err => console.log(err));
19574
- *
19575
- * ```
19576
- */
19577
- getCurrent(): Promise<OpenFin.Window>;
19578
- /**
19579
- * Synchronously returns a Window object that represents the current window
19580
- *
19581
- * @example
19582
- * ```js
19583
- * const wnd = fin.Window.getCurrentSync();
19584
- * const info = await wnd.getInfo();
19585
- * console.log(info);
19586
- *
19587
- * ```
19588
- */
19589
- getCurrentSync(): OpenFin.Window;
19590
- }
19591
-
19592
- /**
19593
- * Generated when a child window is not responding.
19594
- * @interface
19595
- */
19596
- declare type WindowNotRespondingEvent = BaseEvent_3 & {
19597
- type: 'window-not-responding';
19598
- };
19599
-
19600
- /**
19601
- * @interface
19602
- */
19603
- declare type WindowOptionDiff = {
19604
- [key in keyof WindowOptions]: {
19605
- oldVal: WindowOptions[key];
19606
- newVal: WindowOptions[key];
19607
- };
19608
- };
19609
-
19610
- /**
19611
- * @interface
19612
- */
19613
- declare type WindowOptions = MutableWindowOptions & ConstWindowOptions;
19614
-
19615
- declare type WindowOptionsChangedEvent = OpenFin.WindowEvents.WindowOptionsChangedEvent;
19616
-
19617
- /**
19618
- * @deprecated Renamed to {@link OptionsChangedEvent}.
19619
- */
19620
- declare type WindowOptionsChangedEvent_2 = OptionsChangedEvent;
19621
-
19622
- declare type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
19623
-
19624
- /**
19625
- * Generated when a child window is responding.
19626
- * @interface
19627
- */
19628
- declare type WindowRespondingEvent = BaseEvent_3 & {
19629
- type: 'window-responding';
19630
- };
19631
-
19632
- /**
19633
- * @deprecated Renamed to {@link RestoredEvent}.
19634
- */
19635
- declare type WindowRestoredEvent = RestoredEvent;
19636
-
19637
- /**
19638
- * @deprecated Renamed to {@link ShownEvent}.
19639
- */
19640
- declare type WindowShownEvent = ShownEvent_2;
19641
-
19642
- /**
19643
- * @deprecated Renamed to {@link ShowRequestedEvent}.
19644
- */
19645
- declare type WindowShowRequestedEvent = ShowRequestedEvent;
19646
-
19647
- /**
19648
- * A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
19649
- * from {@link OpenFin.ViewEvents}.
19650
- */
19651
- 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;
19652
-
19653
- /**
19654
- * Generated when a child window starts loading.
19655
- * @interface
19656
- */
19657
- declare type WindowStartLoadEvent = BaseEvent_3 & {
19658
- type: 'window-start-load';
19659
- };
19660
-
19661
- /**
19662
- * Visibility state of a window.
19663
- */
19664
- declare type WindowState = 'maximized' | 'minimized' | 'normal';
19665
-
19666
- /**
19667
- * A view-related event that fires natively on the `Window` topic. This means that these events *do* propagate
19668
- * to the `Application` level, with the name pattern `window-view-eventname`.
19669
- */
19670
- declare type WindowViewEvent = {
19671
- viewIdentity: OpenFin.Identity;
19672
- } & (ViewAttachedEvent | ViewDetachedEvent);
19673
-
19674
- /**
19675
- * @interface
19676
- */
19677
- declare type WindowViewsPrintOptions = {
19678
- content: 'views';
19679
- includeSelf?: boolean;
19680
- };
19681
-
19682
- declare type Wire = EventEmitter & {
19683
- connect(messageReciever: MessageReceiver): Promise<any>;
19684
- connectSync(): any;
19685
- send(data: any): Promise<any>;
19686
- shutdown(): Promise<void>;
19687
- getPort(): string;
19688
- };
19689
-
19690
- declare type WireConstructor = {
19691
- new (onmessage: (data: any) => void): Wire;
19692
- };
19693
-
19694
- /* Excluded from this release type: WithId */
19695
-
19696
- declare interface WithInterop {
19697
- interop: InteropClient;
19698
- }
19699
-
19700
- /* Excluded from this release type: WithoutId */
19701
-
19702
- declare type WithPositioningOptions<T extends {} = {}> = T & {
19703
- positioningOptions?: OpenFin.PositioningOptions;
19704
- };
19705
-
19706
- /* Excluded from this release type: WorkspacePlatformOptions */
19707
-
19708
- /**
19709
- * A generic request to write any supported data to the clipboard.
19710
- * @interface
19711
- */
19712
- declare type WriteAnyClipboardRequest = BaseClipboardRequest & {
19713
- /**
19714
- * Data to be written
19715
- */
19716
- data: {
19717
- text?: string;
19718
- html?: string;
19719
- rtf?: string;
19720
- } & Partial<Pick<WriteImageClipboardRequest, 'image'>>;
19721
- };
19722
-
19723
- /**
19724
- * @deprecated - instead use WriteAnyClipboardRequest
19725
- *
19726
- * A generic request to write any supported data to the clipboard.
19727
- *
19728
- * @interface
19729
- */
19730
- declare type WriteAnyRequestType = WriteAnyClipboardRequest;
19731
-
19732
- /**
19733
- * A request to write data to the clipboard.
19734
- * @interface
19735
- */
19736
- declare type WriteClipboardRequest = BaseClipboardRequest & {
19737
- /**
19738
- * Data to write to the clipboard.
19739
- */
19740
- data: string;
19741
- };
19742
-
19743
- /**
19744
- * @interface
19745
- */
19746
- declare type WriteImageClipboardRequest = BaseClipboardRequest & {
19747
- /**
19748
- * Can be either a base64 string, or a DataURL string. If using DataURL, the
19749
- * supported formats are `data:image/png[;base64],` and `data:image/jpeg[;base64],`.
19750
- * Using other image/<format> DataURLs will throw an Error.
19751
- */
19752
- image: string;
19753
- };
19754
-
19755
- /**
19756
- * @deprecated - instead use OpenFin.WriteClipboardRequest
19757
- *
19758
- * A request to write data to the clipboard.
19759
- *
19760
- * @interface
19761
- */
19762
- declare type WriteRequestType = WriteClipboardRequest;
19763
-
19764
- export { }
18051
+ * Dispatch a result to the caller of `showPopupWindow`.
18052
+ *
18053
+ * @remarks If this window isn't currently being shown as a popup, this call will silently fail.
18054
+ * @param data Serializable data to send to the caller window.
18055
+ *
18056
+ * @example
18057
+ * ```js
18058
+ * await fin.me.dispatchPopupResult({
18059
+ * foo: 'bar'
18060
+ * });
18061
+ * ```
18062
+ */
18063
+ dispatchPopupResult(data: any): Promise<void>;
18064
+ /**
18065
+ * Prints the contents of the window.
18066
+ *
18067
+ * @param options Configuration for the print task.
18068
+ * @remarks When `silent` is set to `true`, the API will pick the system's default printer if deviceName is empty
18069
+ * and the default settings for printing.
18070
+ *
18071
+ * Use the CSS style `page-break-before: always;` to force print to a new page.
18072
+ *
18073
+ * @example
18074
+ * ```js
18075
+ * const win = fin.Window.getCurrentSync();
18076
+ *
18077
+ * win.print({ silent: false, deviceName: 'system-printer-name' }).then(() => {
18078
+ * console.log('print call has been sent to the system');
18079
+ * });
18080
+ * ```
18081
+ *
18082
+ * If a window has embedded views, those views will not print by default. To print a window's contents including embedded views,
18083
+ * use the `content` option:
18084
+ *
18085
+ * ```js
18086
+ * const win = fin.Window.getCurrentSync();
18087
+ *
18088
+ * // Print embedded views
18089
+ * win.print({ content: 'views' });
18090
+ *
18091
+ * // Print screenshot of current window
18092
+ * win.print({ content: 'screenshot' })
18093
+ * ```
18094
+ *
18095
+ * When `content` is set to `views`, the embedded views in the platform window will be concatenated and printed as
18096
+ * individual pages. If `includeSelf` is set to `true`, the platform window itself will be printed as the first
18097
+ * page - be aware that this page will *not* include the embedded views - it will only include the contents of
18098
+ * the platform window itself (e.g. tab stacks), with blank spaces where the view contents would be embedded.
18099
+ *
18100
+ * Due to a known issue, view contents that are not visible at the time `print` is called will not appear when
18101
+ * printing `contents: views`. This includes views that are obscured behind other active UI elements.
18102
+ *
18103
+ * To print the views embedded in their page context, set `content` to `screenshot`.
18104
+ */
18105
+ print(options?: OpenFin.WindowPrintOptions): Promise<void>;
18106
+ }
18107
+
18108
+ /**
18109
+ * Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
18110
+ * @interface
18111
+ */
18112
+ declare type WindowAlertRequestedEvent = BaseEvent_3 & {
18113
+ type: 'window-alert-requested';
18114
+ };
18115
+
18116
+ /**
18117
+ * Returned from getBounds call. bottom and right are never used for setting.
18118
+ * @interface
18119
+ */
18120
+ declare type WindowBounds = Bounds & {
18121
+ bottom: number;
18122
+ right: number;
18123
+ };
18124
+
18125
+ /**
18126
+ * @deprecated Renamed to {@link ClosedEvent}.
18127
+ */
18128
+ declare type WindowClosedEvent = ClosedEvent_2;
18129
+
18130
+ /**
18131
+ * @deprecated Renamed to {@link CloseRequestedEvent}.
18132
+ */
18133
+ declare type WindowCloseRequestedEvent = CloseRequestedEvent;
18134
+
18135
+ /**
18136
+ * @deprecated Renamed to {@link ClosingEvent}.
18137
+ */
18138
+ declare type WindowClosingEvent = ClosingEvent;
18139
+
18140
+ /**
18141
+ * A rule prescribing content creation in a {@link OpenFin.Window}.
18142
+ *
18143
+ * @interface
18144
+ */
18145
+ declare type WindowContentCreationRule = BaseContentCreationRule & {
18146
+ /**
18147
+ * Behavior to use when opening matched content.
18148
+ */
18149
+ behavior: 'window';
18150
+ /**
18151
+ * Options for newly-created window.
18152
+ */
18153
+ options?: Partial<WindowOptions>;
18154
+ };
18155
+
18156
+ /**
18157
+ * Generated when a child window is created.
18158
+ * @interface
18159
+ */
18160
+ declare type WindowCreatedEvent = BaseEvent_3 & {
18161
+ type: 'window-created';
18162
+ };
18163
+
18164
+ /**
18165
+ * Options required to create a new window with {@link Window._WindowModule.create Window.create}.
18166
+ *
18167
+ * Note that `name` is the only required property — albeit the `url` property is usually provided as well
18168
+ * (defaults to `"about:blank"` when omitted).
18169
+ * @interface
18170
+ */
18171
+ declare type WindowCreationOptions = Partial<WindowOptions> & {
18172
+ name: string;
18173
+ };
18174
+
18175
+ declare type WindowCreationReason = 'tearout' | 'create-view-without-target' | 'api-call' | 'app-creation' | 'restore' | 'apply-snapshot';
18176
+
18177
+ /**
18178
+ * @interface
18179
+ */
18180
+ declare type WindowDetail = {
18181
+ /**
18182
+ * The bottom-most coordinate of the window.
18183
+ */
18184
+ bottom: number;
18185
+ /**
18186
+ * The height of the window.
18187
+ */
18188
+ height: number;
18189
+ isShowing: boolean;
18190
+ /**
18191
+ * The left-most coordinate of the window.
18192
+ */
18193
+ left: number;
18194
+ /**
18195
+ * The name of the window.
18196
+ */
18197
+ name: string;
18198
+ /**
18199
+ * The right-most coordinate of the window.
18200
+ */
18201
+ right: number;
18202
+ state: string;
18203
+ /**
18204
+ * The top-most coordinate of the window.
18205
+ */
18206
+ top: number;
18207
+ /**
18208
+ * The width of the window.
18209
+ */
18210
+ width: number;
18211
+ };
18212
+
18213
+ /**
18214
+ * Generated when a child window ends loading.
18215
+ * @interface
18216
+ */
18217
+ declare type WindowEndLoadEvent = BaseEvent_3 & {
18218
+ type: 'window-end-load';
18219
+ };
18220
+
18221
+ /**
18222
+ * @deprecated, Renamed to {@link Event}.
18223
+ */
18224
+ declare type WindowEvent = Event_6;
18225
+
18226
+ declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
18227
+
18228
+ declare namespace WindowEvents {
18229
+ export {
18230
+ BaseEvent_5 as BaseEvent,
18231
+ BaseWindowEvent,
18232
+ ViewAttachedEvent,
18233
+ ViewDetachedEvent,
18234
+ WindowViewEvent,
18235
+ AlertRequestedEvent,
18236
+ AuthRequestedEvent,
18237
+ EndLoadEvent,
18238
+ WillRedirectEvent,
18239
+ ReloadedEvent,
18240
+ OptionsChangedEvent,
18241
+ WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
18242
+ ExternalProcessExitedEvent,
18243
+ ExternalProcessStartedEvent,
18244
+ HiddenEvent_2 as HiddenEvent,
18245
+ WindowHiddenEvent,
18246
+ PreloadScriptInfoRunning,
18247
+ PreloadScriptInfo,
18248
+ PreloadScriptsStateChangeEvent,
18249
+ UserBoundsChangeEvent,
18250
+ BoundsChangeEvent,
18251
+ WillMoveOrResizeEvent,
18252
+ PerformanceReportEvent,
18253
+ InputEvent_2 as InputEvent,
18254
+ LayoutInitializedEvent,
18255
+ LayoutReadyEvent,
18256
+ BeginUserBoundsChangingEvent,
18257
+ BoundsChangedEvent,
18258
+ BoundsChangingEvent,
18259
+ CloseRequestedEvent,
18260
+ WindowCloseRequestedEvent,
18261
+ ContextChangedEvent,
18262
+ ClosedEvent_2 as ClosedEvent,
18263
+ WindowClosedEvent,
18264
+ ClosingEvent,
18265
+ WindowClosingEvent,
18266
+ DisabledMovementBoundsChangedEvent,
18267
+ DisabledMovementBoundsChangingEvent,
18268
+ EmbeddedEvent,
18269
+ EndUserBoundsChangingEvent,
18270
+ HotkeyEvent_2 as HotkeyEvent,
18271
+ WindowHotkeyEvent,
18272
+ InitializedEvent_2 as InitializedEvent,
18273
+ WindowInitializedEvent,
18274
+ MaximizedEvent,
18275
+ MinimizedEvent,
18276
+ PreloadScriptsStateChangedEvent,
18277
+ PreloadScriptsStateChangingEvent,
18278
+ RestoredEvent,
18279
+ WindowRestoredEvent,
18280
+ ShowRequestedEvent,
18281
+ WindowShowRequestedEvent,
18282
+ ShownEvent_2 as ShownEvent,
18283
+ WindowShownEvent,
18284
+ UserMovementEnabledEvent,
18285
+ UserMovementDisabledEvent,
18286
+ WillMoveEvent,
18287
+ WillResizeEvent,
18288
+ NonPropagatedWindowEvent,
18289
+ ShowAllDownloadsEvent,
18290
+ DownloadShelfVisibilityChangedEvent,
18291
+ WindowSourcedEvent,
18292
+ WillPropagateWindowEvent,
18293
+ Event_6 as Event,
18294
+ WindowEvent,
18295
+ EventType_2 as EventType,
18296
+ WindowEventType,
18297
+ PropagatedEvent_3 as PropagatedEvent,
18298
+ PropagatedWindowEvent,
18299
+ PropagatedWindowEventType,
18300
+ Payload_3 as Payload,
18301
+ ByType_2 as ByType
18302
+ }
18303
+ }
18304
+
18305
+ /**
18306
+ * @deprecated Renamed to {@link EventType}.
18307
+ */
18308
+ declare type WindowEventType = WindowEvent['type'];
18309
+
18310
+ /**
18311
+ * @deprecated Renamed to {@link HiddenEvent}.
18312
+ */
18313
+ declare type WindowHiddenEvent = HiddenEvent_2;
18314
+
18315
+ /**
18316
+ * @deprecated Renamed to {@link HotkeyEvent}.
18317
+ */
18318
+ declare type WindowHotkeyEvent = HotkeyEvent_2;
18319
+
18320
+ /**
18321
+ * @interface
18322
+ */
18323
+ declare type WindowInfo = {
18324
+ canNavigateBack: boolean;
18325
+ canNavigateForward: boolean;
18326
+ preloadScripts: Array<any>;
18327
+ title: string;
18328
+ url: string;
18329
+ };
18330
+
18331
+ /**
18332
+ * @deprecated Renamed to {@link InitializedEvent}.
18333
+ */
18334
+ declare type WindowInitializedEvent = InitializedEvent_2;
18335
+
18336
+ /**
18337
+ * Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
18338
+ */
18339
+ declare class _WindowModule extends Base {
18340
+ /**
18341
+ * Asynchronously returns a Window object that represents an existing window.
18342
+ *
18343
+ * @example
18344
+ * ```js
18345
+ * async function createWin() {
18346
+ * const app = await fin.Application.start({
18347
+ * name: 'myApp',
18348
+ * uuid: 'app-1',
18349
+ * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrap.html',
18350
+ * autoShow: true
18351
+ * });
18352
+ * return await app.getWindow();
18353
+ * }
18354
+ * createWin().then(() => fin.Window.wrap({ uuid: 'app-1', name: 'myApp' }))
18355
+ * .then(win => console.log('wrapped window'))
18356
+ * .catch(err => console.log(err));
18357
+ * ```
18358
+ */
18359
+ wrap(identity: OpenFin.Identity): Promise<OpenFin.Window>;
18360
+ /**
18361
+ * Synchronously returns a Window object that represents an existing window.
18362
+ *
18363
+ * @example
18364
+ * ```js
18365
+ * async function createWin() {
18366
+ * const app = await fin.Application.start({
18367
+ * name: 'myApp',
18368
+ * uuid: 'app-1',
18369
+ * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrapSync.html',
18370
+ * autoShow: true
18371
+ * });
18372
+ * return await app.getWindow();
18373
+ * }
18374
+ * await createWin();
18375
+ * let win = fin.Window.wrapSync({ uuid: 'app-1', name: 'myApp' });
18376
+ * ```
18377
+ */
18378
+ wrapSync(identity: OpenFin.Identity): OpenFin.Window;
18379
+ /**
18380
+ * Creates a new Window.
18381
+ * @param options - Window creation options
18382
+ *
18383
+ * @example
18384
+ * ```js
18385
+ * async function createWindow() {
18386
+ * const winOption = {
18387
+ * name:'child',
18388
+ * defaultWidth: 300,
18389
+ * defaultHeight: 300,
18390
+ * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.create.html',
18391
+ * frame: true,
18392
+ * autoShow: true
18393
+ * };
18394
+ * return await fin.Window.create(winOption);
18395
+ * }
18396
+ *
18397
+ * createWindow().then(() => console.log('Window is created')).catch(err => console.log(err));
18398
+ * ```
18399
+ */
18400
+ create(options: OpenFin.WindowCreationOptions): Promise<OpenFin.Window>;
18401
+ /**
18402
+ * Asynchronously returns a Window object that represents the current window
18403
+ *
18404
+ * @example
18405
+ * ```js
18406
+ * fin.Window.getCurrent()
18407
+ * .then(wnd => console.log('current window'))
18408
+ * .catch(err => console.log(err));
18409
+ *
18410
+ * ```
18411
+ */
18412
+ getCurrent(): Promise<OpenFin.Window>;
18413
+ /**
18414
+ * Synchronously returns a Window object that represents the current window
18415
+ *
18416
+ * @example
18417
+ * ```js
18418
+ * const wnd = fin.Window.getCurrentSync();
18419
+ * const info = await wnd.getInfo();
18420
+ * console.log(info);
18421
+ *
18422
+ * ```
18423
+ */
18424
+ getCurrentSync(): OpenFin.Window;
18425
+ }
18426
+
18427
+ /**
18428
+ * Generated when a child window is not responding.
18429
+ * @interface
18430
+ */
18431
+ declare type WindowNotRespondingEvent = BaseEvent_3 & {
18432
+ type: 'window-not-responding';
18433
+ };
18434
+
18435
+ /**
18436
+ * @interface
18437
+ */
18438
+ declare type WindowOptionDiff = {
18439
+ [key in keyof WindowOptions]: {
18440
+ oldVal: WindowOptions[key];
18441
+ newVal: WindowOptions[key];
18442
+ };
18443
+ };
18444
+
18445
+ /**
18446
+ * @interface
18447
+ */
18448
+ declare type WindowOptions = MutableWindowOptions & ConstWindowOptions;
18449
+
18450
+ declare type WindowOptionsChangedEvent = OpenFin.WindowEvents.WindowOptionsChangedEvent;
18451
+
18452
+ /**
18453
+ * @deprecated Renamed to {@link OptionsChangedEvent}.
18454
+ */
18455
+ declare type WindowOptionsChangedEvent_2 = OptionsChangedEvent;
18456
+
18457
+ declare type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
18458
+
18459
+ /**
18460
+ * Generated when a child window is responding.
18461
+ * @interface
18462
+ */
18463
+ declare type WindowRespondingEvent = BaseEvent_3 & {
18464
+ type: 'window-responding';
18465
+ };
18466
+
18467
+ /**
18468
+ * @deprecated Renamed to {@link RestoredEvent}.
18469
+ */
18470
+ declare type WindowRestoredEvent = RestoredEvent;
18471
+
18472
+ /**
18473
+ * @deprecated Renamed to {@link ShownEvent}.
18474
+ */
18475
+ declare type WindowShownEvent = ShownEvent_2;
18476
+
18477
+ /**
18478
+ * @deprecated Renamed to {@link ShowRequestedEvent}.
18479
+ */
18480
+ declare type WindowShowRequestedEvent = ShowRequestedEvent;
18481
+
18482
+ /**
18483
+ * A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
18484
+ * from {@link OpenFin.ViewEvents}.
18485
+ */
18486
+ 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;
18487
+
18488
+ /**
18489
+ * Generated when a child window starts loading.
18490
+ * @interface
18491
+ */
18492
+ declare type WindowStartLoadEvent = BaseEvent_3 & {
18493
+ type: 'window-start-load';
18494
+ };
18495
+
18496
+ /**
18497
+ * Visibility state of a window.
18498
+ */
18499
+ declare type WindowState = 'maximized' | 'minimized' | 'normal';
18500
+
18501
+ /**
18502
+ * A view-related event that fires natively on the `Window` topic. This means that these events *do* propagate
18503
+ * to the `Application` level, with the name pattern `window-view-eventname`.
18504
+ */
18505
+ declare type WindowViewEvent = {
18506
+ viewIdentity: OpenFin.Identity;
18507
+ } & (ViewAttachedEvent | ViewDetachedEvent);
18508
+
18509
+ /**
18510
+ * @interface
18511
+ */
18512
+ declare type WindowViewsPrintOptions = {
18513
+ content: 'views';
18514
+ includeSelf?: boolean;
18515
+ };
18516
+
18517
+ declare type Wire = EventEmitter & {
18518
+ connect(messageReciever: MessageReceiver): Promise<any>;
18519
+ connectSync(): any;
18520
+ send(data: any): Promise<any>;
18521
+ shutdown(): Promise<void>;
18522
+ getPort(): string;
18523
+ };
18524
+
18525
+ declare type WireConstructor = {
18526
+ new (onmessage: (data: any) => void): Wire;
18527
+ };
18528
+
18529
+ /* Excluded from this release type: WithId */
18530
+
18531
+ declare interface WithInterop {
18532
+ interop: InteropClient;
18533
+ }
18534
+
18535
+ /* Excluded from this release type: WithoutId */
18536
+
18537
+ declare type WithPositioningOptions<T extends {} = {}> = T & {
18538
+ positioningOptions?: OpenFin.PositioningOptions;
18539
+ };
18540
+
18541
+ /* Excluded from this release type: WorkspacePlatformOptions */
18542
+
18543
+ /**
18544
+ * A generic request to write any supported data to the clipboard.
18545
+ * @interface
18546
+ */
18547
+ declare type WriteAnyClipboardRequest = BaseClipboardRequest & {
18548
+ /**
18549
+ * Data to be written
18550
+ */
18551
+ data: {
18552
+ text?: string;
18553
+ html?: string;
18554
+ rtf?: string;
18555
+ } & Partial<Pick<WriteImageClipboardRequest, 'image'>>;
18556
+ };
18557
+
18558
+ /**
18559
+ * @deprecated - instead use WriteAnyClipboardRequest
18560
+ *
18561
+ * A generic request to write any supported data to the clipboard.
18562
+ *
18563
+ * @interface
18564
+ */
18565
+ declare type WriteAnyRequestType = WriteAnyClipboardRequest;
18566
+
18567
+ /**
18568
+ * A request to write data to the clipboard.
18569
+ * @interface
18570
+ */
18571
+ declare type WriteClipboardRequest = BaseClipboardRequest & {
18572
+ /**
18573
+ * Data to write to the clipboard.
18574
+ */
18575
+ data: string;
18576
+ };
18577
+
18578
+ /**
18579
+ * @interface
18580
+ */
18581
+ declare type WriteImageClipboardRequest = BaseClipboardRequest & {
18582
+ /**
18583
+ * Can be either a base64 string, or a DataURL string. If using DataURL, the
18584
+ * supported formats are `data:image/png[;base64],` and `data:image/jpeg[;base64],`.
18585
+ * Using other image/<format> DataURLs will throw an Error.
18586
+ */
18587
+ image: string;
18588
+ };
18589
+
18590
+ /**
18591
+ * @deprecated - instead use OpenFin.WriteClipboardRequest
18592
+ *
18593
+ * A request to write data to the clipboard.
18594
+ *
18595
+ * @interface
18596
+ */
18597
+ declare type WriteRequestType = WriteClipboardRequest;
18598
+
18599
+ export { }