@openfin/node-adapter 34.78.62 → 35.78.4

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