@openfin/core 35.78.6 → 35.78.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/out/mock-alpha.d.ts +654 -1783
- package/out/mock-beta.d.ts +654 -1783
- package/out/mock-public.d.ts +654 -1783
- package/out/mock.d.ts +675 -2004
- package/out/mock.js +70 -1401
- package/package.json +1 -1
package/out/mock.d.ts
CHANGED
|
@@ -43,6 +43,8 @@ declare type Accelerator = {
|
|
|
43
43
|
};
|
|
44
44
|
|
|
45
45
|
/**
|
|
46
|
+
* Options to use when adding a view to a {@link TabStack}.
|
|
47
|
+
*
|
|
46
48
|
* @interface
|
|
47
49
|
*/
|
|
48
50
|
declare type AddViewOptions = CreateViewTarget & {
|
|
@@ -94,6 +96,10 @@ declare type Api = {
|
|
|
94
96
|
sameOriginInjection?: boolean;
|
|
95
97
|
enableDeprecatedSharedName?: boolean;
|
|
96
98
|
};
|
|
99
|
+
/**
|
|
100
|
+
* Prevent fin API injection. If 'none', `fin` won't be available in this context.
|
|
101
|
+
*/
|
|
102
|
+
fin?: InjectionType;
|
|
97
103
|
};
|
|
98
104
|
|
|
99
105
|
declare type ApiCall<Request, Response> = {
|
|
@@ -193,100 +199,6 @@ declare class Application extends EmitterBase<OpenFin_2.ApplicationEvent> {
|
|
|
193
199
|
*/
|
|
194
200
|
constructor(wire: Transport, identity: OpenFin_2.ApplicationIdentity);
|
|
195
201
|
private windowListFromIdentityList;
|
|
196
|
-
/**
|
|
197
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
|
198
|
-
* @param eventType - The type of the event.
|
|
199
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
|
200
|
-
* @param options - Option to support event timestamps.
|
|
201
|
-
*
|
|
202
|
-
* @function addListener
|
|
203
|
-
* @memberof Application
|
|
204
|
-
* @instance
|
|
205
|
-
* @tutorial Application.EventEmitter
|
|
206
|
-
*/
|
|
207
|
-
/**
|
|
208
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
|
209
|
-
* @param eventType - The type of the event.
|
|
210
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
|
211
|
-
* @param options - Option to support event timestamps.
|
|
212
|
-
*
|
|
213
|
-
* @function on
|
|
214
|
-
* @memberof Application
|
|
215
|
-
* @instance
|
|
216
|
-
* @tutorial Application.EventEmitter
|
|
217
|
-
*/
|
|
218
|
-
/**
|
|
219
|
-
* Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
|
|
220
|
-
* @param eventType - The type of the event.
|
|
221
|
-
* @param listener - The callback function.
|
|
222
|
-
* @param options - Option to support event timestamps.
|
|
223
|
-
*
|
|
224
|
-
* @function once
|
|
225
|
-
* @memberof Application
|
|
226
|
-
* @instance
|
|
227
|
-
* @tutorial Application.EventEmitter
|
|
228
|
-
*/
|
|
229
|
-
/**
|
|
230
|
-
* Adds a listener to the beginning of the listeners array for the specified event.
|
|
231
|
-
* @param eventType - The type of the event.
|
|
232
|
-
* @param listener - The callback function.
|
|
233
|
-
* @param options - Option to support event timestamps.
|
|
234
|
-
*
|
|
235
|
-
* @function prependListener
|
|
236
|
-
* @memberof Application
|
|
237
|
-
* @instance
|
|
238
|
-
* @tutorial Application.EventEmitter
|
|
239
|
-
*/
|
|
240
|
-
/**
|
|
241
|
-
* Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
|
|
242
|
-
* The listener is added to the beginning of the listeners array.
|
|
243
|
-
* @param eventType - The type of the event.
|
|
244
|
-
* @param listener - The callback function.
|
|
245
|
-
* @param options - Option to support event timestamps.
|
|
246
|
-
*
|
|
247
|
-
* @function prependOnceListener
|
|
248
|
-
* @memberof Application
|
|
249
|
-
* @instance
|
|
250
|
-
* @tutorial Application.EventEmitter
|
|
251
|
-
*/
|
|
252
|
-
/**
|
|
253
|
-
* Remove a listener from the listener array for the specified event.
|
|
254
|
-
* Caution: Calling this method changes the array indices in the listener array behind the listener.
|
|
255
|
-
* @param eventType - The type of the event.
|
|
256
|
-
* @param listener - The callback function.
|
|
257
|
-
* @param options - Option to support event timestamps.
|
|
258
|
-
*
|
|
259
|
-
* @function removeListener
|
|
260
|
-
* @memberof Application
|
|
261
|
-
* @instance
|
|
262
|
-
* @tutorial Application.EventEmitter
|
|
263
|
-
*/
|
|
264
|
-
/**
|
|
265
|
-
* Removes all listeners, or those of the specified event.
|
|
266
|
-
* @param eventType - The type of the event.
|
|
267
|
-
*
|
|
268
|
-
* @function removeAllListeners
|
|
269
|
-
* @memberof Application
|
|
270
|
-
* @instance
|
|
271
|
-
* @tutorial Application.EventEmitter
|
|
272
|
-
*/
|
|
273
|
-
/**
|
|
274
|
-
* JumpListCategory interface
|
|
275
|
-
* @typedef { object } JumpListCategory@typedef { object } JumpListCategory
|
|
276
|
-
* @property { string } name The display title for the category. If omitted, items in this category will be placed into the standard 'Tasks' category. There can be only one such category, and it will always be displayed at the bottom of the JumpList.
|
|
277
|
-
* @property { JumpListItem[] } items Array of JumpListItem objects
|
|
278
|
-
*/
|
|
279
|
-
/**
|
|
280
|
-
* @PORTED
|
|
281
|
-
* JumpListItem interface
|
|
282
|
-
* @typedef { object } JumpListItem@typedef { object } JumpListItem
|
|
283
|
-
* @property { string } type One of the following: "task" or "separator". Defaults to task.
|
|
284
|
-
* @property { string } title The text to be displayed for the JumpList Item. Should only be set if type is "task".
|
|
285
|
-
* @property { string } description Description of the task (displayed in a tooltip). Should only be set if type is "task".
|
|
286
|
-
* @property { string } deepLink Deep link to a manifest, i.e: fins://path.to/manifest.json?$$param1=value1. See {@link https://developers.openfin.co/docs/deep-linking deep-linking} for more information.
|
|
287
|
-
* @property { string } iconPath The absolute path to an icon to be displayed for the item, which can be an arbitrary resource file that contains an icon (e.g. .ico, .exe, .dll).
|
|
288
|
-
* @property { number } iconIndex The index of the icon in the resource file. If a resource file contains multiple icons this value can be used to specify the zero-based index of the icon that should be displayed for this task. If a resource file contains only one icon, this property should be set to zero.
|
|
289
|
-
*/
|
|
290
202
|
/**
|
|
291
203
|
* Determines if the application is currently running.
|
|
292
204
|
*
|
|
@@ -933,6 +845,7 @@ declare namespace ApplicationEvents {
|
|
|
933
845
|
RespondingEvent,
|
|
934
846
|
StartedEvent,
|
|
935
847
|
ApplicationSourcedEvent,
|
|
848
|
+
ApplicationSourcedEventType,
|
|
936
849
|
Event_3 as Event,
|
|
937
850
|
ApplicationEvent,
|
|
938
851
|
EventType_3 as EventType,
|
|
@@ -1305,6 +1218,11 @@ declare type ApplicationPermissions = {
|
|
|
1305
1218
|
*/
|
|
1306
1219
|
declare type ApplicationSourcedEvent = ClosedEvent | ConnectedEvent_2 | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent_2 | StartedEvent | TrayIconClickedEvent | FileDownloadLocationChangedEvent;
|
|
1307
1220
|
|
|
1221
|
+
/**
|
|
1222
|
+
* Union of possible type values for an {@link ApplicationSourcedEvent}.
|
|
1223
|
+
*/
|
|
1224
|
+
declare type ApplicationSourcedEventType = ApplicationSourcedEvent['type'];
|
|
1225
|
+
|
|
1308
1226
|
declare type ApplicationState = OpenFin_2.ApplicationState;
|
|
1309
1227
|
|
|
1310
1228
|
/**
|
|
@@ -3142,20 +3060,6 @@ declare type ClientInfo = Omit<ClientIdentity, 'isLocalEndpointId'> & {
|
|
|
3142
3060
|
connectionUrl: string;
|
|
3143
3061
|
};
|
|
3144
3062
|
|
|
3145
|
-
/**
|
|
3146
|
-
* @PORTED
|
|
3147
|
-
* WriteRequestType interface
|
|
3148
|
-
* @typedef { object } WriteRequestType@typedef { object } WriteRequestType
|
|
3149
|
-
* @property { string } data Data to be written
|
|
3150
|
-
* @property { string } [type] Clipboard Type
|
|
3151
|
-
*/
|
|
3152
|
-
/**
|
|
3153
|
-
* @PORTED
|
|
3154
|
-
* OpenFin.WriteAnyClipboardRequest interface
|
|
3155
|
-
* @typedef { object } OpenFin.WriteAnyClipboardRequest@typedef { object } OpenFin.WriteAnyClipboardRequest
|
|
3156
|
-
* @property { string } data Data to be written
|
|
3157
|
-
* @property { OpenFin.ClipboardSelectionType } [type] Clipboard Type defaults to 'clipboard', use 'selection' for linux
|
|
3158
|
-
*/
|
|
3159
3063
|
/**
|
|
3160
3064
|
* The Clipboard API allows reading and writing to the clipboard in multiple formats.
|
|
3161
3065
|
*
|
|
@@ -3411,57 +3315,6 @@ declare type ClosingEvent = BaseEvent_5 & {
|
|
|
3411
3315
|
*/
|
|
3412
3316
|
declare class ColumnOrRow extends LayoutNode {
|
|
3413
3317
|
#private;
|
|
3414
|
-
/**
|
|
3415
|
-
* Determines if this {@link ColumnOrRow} is the top level content item in the current layout.
|
|
3416
|
-
* @function isRoot
|
|
3417
|
-
* @memberof ColumnOrRow
|
|
3418
|
-
* @instance
|
|
3419
|
-
* @tutorial ColumnOrRow.isRoot
|
|
3420
|
-
* @returns Resolves true if this TabStack is the top level content item, or false if it is not.
|
|
3421
|
-
*/
|
|
3422
|
-
/**
|
|
3423
|
-
* Determines if this {@link ColumnOrRow} exists.
|
|
3424
|
-
* @function exists
|
|
3425
|
-
* @instance
|
|
3426
|
-
* @memberof ColumnOrRow
|
|
3427
|
-
* @tutorial ColumnOrRow.exists
|
|
3428
|
-
* @returns Resolves true if the TabStack exists, or false if it has been destroyed.
|
|
3429
|
-
*/
|
|
3430
|
-
/**
|
|
3431
|
-
* Retrieves the parent {@link ColumnOrRow} of this {@link ColumnOrRow}, if one exists.
|
|
3432
|
-
* @function getParent
|
|
3433
|
-
* @instance
|
|
3434
|
-
* @memberof ColumnOrRow
|
|
3435
|
-
* @tutorial ColumnOrRow.getParent
|
|
3436
|
-
* @returns Promise resolving with the {@link ColumnOrRow} that contains this item, or undefined if
|
|
3437
|
-
* this {@link ColumnOrRow}does not exist or is the root content item.
|
|
3438
|
-
*/
|
|
3439
|
-
/**
|
|
3440
|
-
* Returns all the adjacent stacks that share an edge with the given {@link ColumnOrRow}.
|
|
3441
|
-
* @function getAdjacentStacks
|
|
3442
|
-
* @instance
|
|
3443
|
-
* @memberof ColumnOrRow
|
|
3444
|
-
* @param {LayoutPosition} edge - Edge to check for any adjacent stacks.
|
|
3445
|
-
*
|
|
3446
|
-
* @tutorial ColumnOrRow.getAdjacentStacks
|
|
3447
|
-
*/
|
|
3448
|
-
/**
|
|
3449
|
-
* Given a list of view creation options or references and a layout position, creates a {@link TabStack} adjacent to the given {@link ColumnOrRow}
|
|
3450
|
-
*
|
|
3451
|
-
* Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
|
|
3452
|
-
* during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
|
|
3453
|
-
* This means the views you pass to createAdjacentStack() may not render in the order given by the array.
|
|
3454
|
-
* Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
|
|
3455
|
-
*
|
|
3456
|
-
* @function createAdjacentStack
|
|
3457
|
-
* @instance
|
|
3458
|
-
* @memberof ColumnOrRow
|
|
3459
|
-
* @param views - List of identities or view creation options of the views to include in the stack
|
|
3460
|
-
* @param options - Creation options.
|
|
3461
|
-
* @returns The created TabStack
|
|
3462
|
-
* @tutorial ColumnOrRow.createAdjacentStack
|
|
3463
|
-
* @experimental
|
|
3464
|
-
*/
|
|
3465
3318
|
/**
|
|
3466
3319
|
* @internal
|
|
3467
3320
|
*/
|
|
@@ -3582,6 +3435,10 @@ declare type ConstructorOverride<T> = (Base: Constructor<T>) => Constructor<T>;
|
|
|
3582
3435
|
* @interface
|
|
3583
3436
|
*/
|
|
3584
3437
|
declare type ConstViewOptions = {
|
|
3438
|
+
/**
|
|
3439
|
+
* Configurations for API injection.
|
|
3440
|
+
*/
|
|
3441
|
+
api: Api;
|
|
3585
3442
|
/**
|
|
3586
3443
|
* The name of the view.
|
|
3587
3444
|
*/
|
|
@@ -3730,7 +3587,7 @@ declare type ConstWindowOptions = {
|
|
|
3730
3587
|
/**
|
|
3731
3588
|
* @defaultValue true
|
|
3732
3589
|
*
|
|
3733
|
-
*
|
|
3590
|
+
* Setting this to false would keep the Window alive even if all its Views were closed.
|
|
3734
3591
|
* This is meant for advanced users and should be used with caution.
|
|
3735
3592
|
* Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
|
|
3736
3593
|
* Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
|
|
@@ -3740,7 +3597,8 @@ declare type ConstWindowOptions = {
|
|
|
3740
3597
|
/**
|
|
3741
3598
|
* @defaultValue 'all'
|
|
3742
3599
|
*
|
|
3743
|
-
*
|
|
3600
|
+
* When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
|
|
3601
|
+
+ * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
|
|
3744
3602
|
* **NOTE:** - This option is ignored in non-Platforms apps.
|
|
3745
3603
|
*/
|
|
3746
3604
|
viewsPreventingClose: 'all' | 'layout';
|
|
@@ -4547,7 +4405,7 @@ declare type CreateViewPayload = {
|
|
|
4547
4405
|
/**
|
|
4548
4406
|
* @interface
|
|
4549
4407
|
*/
|
|
4550
|
-
declare type CreateViewTarget = LayoutIdentity & {
|
|
4408
|
+
declare type CreateViewTarget = (Identity_5 | LayoutIdentity) & {
|
|
4551
4409
|
/**
|
|
4552
4410
|
* If specified, view creation will not attach to a window and caller must
|
|
4553
4411
|
* insert the view into the layout explicitly
|
|
@@ -4687,6 +4545,14 @@ declare type DestroyedEvent = BaseEvent_4 & {
|
|
|
4687
4545
|
type: 'destroyed';
|
|
4688
4546
|
};
|
|
4689
4547
|
|
|
4548
|
+
/**
|
|
4549
|
+
* @interface
|
|
4550
|
+
*/
|
|
4551
|
+
declare type DeviceInfo = {
|
|
4552
|
+
vendorId: string | number;
|
|
4553
|
+
productId: string | number;
|
|
4554
|
+
};
|
|
4555
|
+
|
|
4690
4556
|
/**
|
|
4691
4557
|
* Generated when a page's theme color changes. This is usually due to encountering a meta tag.
|
|
4692
4558
|
* @interface
|
|
@@ -4928,7 +4794,7 @@ declare type DownloadShelfOptions = {
|
|
|
4928
4794
|
*/
|
|
4929
4795
|
size?: number;
|
|
4930
4796
|
/**
|
|
4931
|
-
* Color of the border
|
|
4797
|
+
* Color of the border. Must be a 6-character hex code prefixed by #. Defaults to chromium theme
|
|
4932
4798
|
* if absent.
|
|
4933
4799
|
*/
|
|
4934
4800
|
color?: string;
|
|
@@ -5152,9 +5018,10 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
|
|
|
5152
5018
|
} : never;
|
|
5153
5019
|
|
|
5154
5020
|
declare interface Environment {
|
|
5155
|
-
|
|
5021
|
+
initLayoutManager(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, wire: Transport, options: OpenFin_2.InitLayoutOptions): Promise<OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>>;
|
|
5156
5022
|
createLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, options: OpenFin_2.CreateLayoutOptions): Promise<void>;
|
|
5157
5023
|
destroyLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<void>;
|
|
5024
|
+
resolveLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<any>;
|
|
5158
5025
|
initPlatform(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, ...args: Parameters<OpenFin_2.Fin['Platform']['init']>): ReturnType<OpenFin_2.Fin['Platform']['init']>;
|
|
5159
5026
|
observeBounds(element: Element, onChange: (bounds: DOMRect) => Promise<void> | void): () => void;
|
|
5160
5027
|
writeToken(path: string, token: string): Promise<string>;
|
|
@@ -5376,7 +5243,7 @@ declare type EventType_7 = Event_10['type'];
|
|
|
5376
5243
|
/**
|
|
5377
5244
|
* Union of possible `type` values for a {@link SystemEvent}.
|
|
5378
5245
|
*/
|
|
5379
|
-
declare type EventType_8 =
|
|
5246
|
+
declare type EventType_8 = Event_11['type'];
|
|
5380
5247
|
|
|
5381
5248
|
/**
|
|
5382
5249
|
* @internal
|
|
@@ -5429,83 +5296,6 @@ declare class ExternalApplication extends EmitterBase<OpenFin_2.ExternalApplicat
|
|
|
5429
5296
|
* @internal
|
|
5430
5297
|
*/
|
|
5431
5298
|
constructor(wire: Transport, identity: OpenFin_2.ApplicationIdentity);
|
|
5432
|
-
/**
|
|
5433
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
|
5434
|
-
* @param eventType - The type of the event.
|
|
5435
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
|
5436
|
-
* @param options - Option to support event timestamps.
|
|
5437
|
-
*
|
|
5438
|
-
* @function addListener
|
|
5439
|
-
* @memberof ExternalApplication
|
|
5440
|
-
* @instance
|
|
5441
|
-
* @tutorial ExternalApplication.EventEmitter
|
|
5442
|
-
*/
|
|
5443
|
-
/**
|
|
5444
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
|
5445
|
-
* @param eventType - The type of the event.
|
|
5446
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
|
5447
|
-
* @param options - Option to support event timestamps.
|
|
5448
|
-
*
|
|
5449
|
-
* @function on
|
|
5450
|
-
* @memberof ExternalApplication
|
|
5451
|
-
* @instance
|
|
5452
|
-
* @tutorial ExternalApplication.EventEmitter
|
|
5453
|
-
*/
|
|
5454
|
-
/**
|
|
5455
|
-
* 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.
|
|
5456
|
-
* @param eventType - The type of the event.
|
|
5457
|
-
* @param listener - The callback function.
|
|
5458
|
-
* @param options - Option to support event timestamps.
|
|
5459
|
-
*
|
|
5460
|
-
* @function once
|
|
5461
|
-
* @memberof ExternalApplication
|
|
5462
|
-
* @instance
|
|
5463
|
-
* @tutorial ExternalApplication.EventEmitter
|
|
5464
|
-
*/
|
|
5465
|
-
/**
|
|
5466
|
-
* Adds a listener to the beginning of the listeners array for the specified event.
|
|
5467
|
-
* @param eventType - The type of the event.
|
|
5468
|
-
* @param listener - The callback function.
|
|
5469
|
-
* @param options - Option to support event timestamps.
|
|
5470
|
-
*
|
|
5471
|
-
* @function prependListener
|
|
5472
|
-
* @memberof ExternalApplication
|
|
5473
|
-
* @instance
|
|
5474
|
-
* @tutorial ExternalApplication.EventEmitter
|
|
5475
|
-
*/
|
|
5476
|
-
/**
|
|
5477
|
-
* 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.
|
|
5478
|
-
* The listener is added to the beginning of the listeners array.
|
|
5479
|
-
* @param eventType - The type of the event.
|
|
5480
|
-
* @param listener - The callback function.
|
|
5481
|
-
* @param options - Option to support event timestamps.
|
|
5482
|
-
*
|
|
5483
|
-
* @function prependOnceListener
|
|
5484
|
-
* @memberof ExternalApplication
|
|
5485
|
-
* @instance
|
|
5486
|
-
* @tutorial ExternalApplication.EventEmitter
|
|
5487
|
-
*/
|
|
5488
|
-
/**
|
|
5489
|
-
* Remove a listener from the listener array for the specified event.
|
|
5490
|
-
* Caution: Calling this method changes the array indices in the listener array behind the listener.
|
|
5491
|
-
* @param eventType - The type of the event.
|
|
5492
|
-
* @param listener - The callback function.
|
|
5493
|
-
* @param options - Option to support event timestamps.
|
|
5494
|
-
*
|
|
5495
|
-
* @function removeListener
|
|
5496
|
-
* @memberof ExternalApplication
|
|
5497
|
-
* @instance
|
|
5498
|
-
* @tutorial ExternalApplication.EventEmitter
|
|
5499
|
-
*/
|
|
5500
|
-
/**
|
|
5501
|
-
* Removes all listeners, or those of the specified event.
|
|
5502
|
-
* @param eventType - The type of the event.
|
|
5503
|
-
*
|
|
5504
|
-
* @function removeAllListeners
|
|
5505
|
-
* @memberof ExternalApplication
|
|
5506
|
-
* @instance
|
|
5507
|
-
* @tutorial ExternalApplication.EventEmitter
|
|
5508
|
-
*/
|
|
5509
5299
|
/**
|
|
5510
5300
|
* Retrieves information about the external application.
|
|
5511
5301
|
*
|
|
@@ -5924,83 +5714,6 @@ declare class _Frame extends EmitterBase<OpenFin_2.FrameEvent> {
|
|
|
5924
5714
|
* @internal
|
|
5925
5715
|
*/
|
|
5926
5716
|
constructor(wire: Transport, identity: OpenFin_2.Identity);
|
|
5927
|
-
/**
|
|
5928
|
-
* Adds the listener function to the end of the listeners array for the specified event type.
|
|
5929
|
-
* @param eventType - The type of the event.
|
|
5930
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
|
5931
|
-
* @param options - Option to support event timestamps.
|
|
5932
|
-
*
|
|
5933
|
-
* @function addListener
|
|
5934
|
-
* @memberof Frame
|
|
5935
|
-
* @instance
|
|
5936
|
-
* @tutorial Frame.EventEmitter
|
|
5937
|
-
*/
|
|
5938
|
-
/**
|
|
5939
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
|
5940
|
-
* @param eventType - The type of the event.
|
|
5941
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
|
5942
|
-
* @param options - Option to support event timestamps.
|
|
5943
|
-
*
|
|
5944
|
-
* @function on
|
|
5945
|
-
* @memberof Frame
|
|
5946
|
-
* @instance
|
|
5947
|
-
* @tutorial Frame.EventEmitter
|
|
5948
|
-
*/
|
|
5949
|
-
/**
|
|
5950
|
-
* 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.
|
|
5951
|
-
* @param eventType - The type of the event.
|
|
5952
|
-
* @param listener - The callback function.
|
|
5953
|
-
* @param options - Option to support event timestamps.
|
|
5954
|
-
*
|
|
5955
|
-
* @function once
|
|
5956
|
-
* @memberof Frame
|
|
5957
|
-
* @instance
|
|
5958
|
-
* @tutorial Frame.EventEmitter
|
|
5959
|
-
*/
|
|
5960
|
-
/**
|
|
5961
|
-
* Adds a listener to the beginning of the listeners array for the specified event.
|
|
5962
|
-
* @param eventType - The type of the event.
|
|
5963
|
-
* @param listener - The callback function.
|
|
5964
|
-
* @param options - Option to support event timestamps.
|
|
5965
|
-
*
|
|
5966
|
-
* @function prependListener
|
|
5967
|
-
* @memberof Frame
|
|
5968
|
-
* @instance
|
|
5969
|
-
* @tutorial Frame.EventEmitter
|
|
5970
|
-
*/
|
|
5971
|
-
/**
|
|
5972
|
-
* 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.
|
|
5973
|
-
* The listener is added to the beginning of the listeners array.
|
|
5974
|
-
* @param eventType - The type of the event.
|
|
5975
|
-
* @param listener - The callback function.
|
|
5976
|
-
* @param options - Option to support event timestamps.
|
|
5977
|
-
*
|
|
5978
|
-
* @function prependOnceListener
|
|
5979
|
-
* @memberof Frame
|
|
5980
|
-
* @instance
|
|
5981
|
-
* @tutorial Frame.EventEmitter
|
|
5982
|
-
*/
|
|
5983
|
-
/**
|
|
5984
|
-
* Remove a listener from the listener array for the specified event.
|
|
5985
|
-
* Caution: Calling this method changes the array indices in the listener array behind the listener.
|
|
5986
|
-
* @param eventType - The type of the event.
|
|
5987
|
-
* @param listener - The callback function.
|
|
5988
|
-
* @param options - Option to support event timestamps.
|
|
5989
|
-
*
|
|
5990
|
-
* @function removeListener
|
|
5991
|
-
* @memberof Frame
|
|
5992
|
-
* @instance
|
|
5993
|
-
* @tutorial Frame.EventEmitter
|
|
5994
|
-
*/
|
|
5995
|
-
/**
|
|
5996
|
-
* Removes all listeners, or those of the specified event.
|
|
5997
|
-
* @param eventType - The type of the event.
|
|
5998
|
-
*
|
|
5999
|
-
* @function removeAllListeners
|
|
6000
|
-
* @memberof Frame
|
|
6001
|
-
* @instance
|
|
6002
|
-
* @tutorial Frame.EventEmitter
|
|
6003
|
-
*/
|
|
6004
5717
|
/**
|
|
6005
5718
|
* Returns a frame info object for the represented frame.
|
|
6006
5719
|
*
|
|
@@ -6925,6 +6638,8 @@ declare type InitPlatformOptions = {
|
|
|
6925
6638
|
interopOverride?: OverrideCallback<InteropBroker> | ConstructorOverride<InteropBroker>[];
|
|
6926
6639
|
};
|
|
6927
6640
|
|
|
6641
|
+
declare type InjectionType = 'none' | 'global';
|
|
6642
|
+
|
|
6928
6643
|
/**
|
|
6929
6644
|
* Generated when the value of the element changes.
|
|
6930
6645
|
* @interface
|
|
@@ -7284,56 +6999,6 @@ declare class InteropBroker extends Base {
|
|
|
7284
6999
|
static createClosedConstructor(...args: ConstructorParameters<typeof InteropBroker>): {
|
|
7285
7000
|
new (): InteropBroker;
|
|
7286
7001
|
};
|
|
7287
|
-
/**
|
|
7288
|
-
* @REMOVED
|
|
7289
|
-
* SetContextOptions interface
|
|
7290
|
-
* @typedef { object } SetContextOptions@typedef { object } SetContextOptions
|
|
7291
|
-
* @property { Context } {context} - New context to set.
|
|
7292
|
-
*/
|
|
7293
|
-
/**
|
|
7294
|
-
* @REMOVED
|
|
7295
|
-
* GetContextOptions interface
|
|
7296
|
-
* @typedef { object } GetContextOptions@typedef { object } GetContextOptions
|
|
7297
|
-
* @property { string } [contextType] - Context Type
|
|
7298
|
-
*/
|
|
7299
|
-
/**
|
|
7300
|
-
* @REMOVED
|
|
7301
|
-
* JoinContextGroupOptions interface
|
|
7302
|
-
* @typedef { object } JoinContextGroupOptions@typedef { object } JoinContextGroupOptions
|
|
7303
|
-
* @property { string } contextGroupId - Id of the context group.
|
|
7304
|
-
* @property { Identity | ClientIdentity } [target] - Identity of the entity you wish to join to a context group.
|
|
7305
|
-
*/
|
|
7306
|
-
/**
|
|
7307
|
-
* @REMOVED
|
|
7308
|
-
* AddClientToContextGroupOptions interface
|
|
7309
|
-
* @typedef { object } AddClientToContextGroupOptions@typedef { object } AddClientToContextGroupOptions
|
|
7310
|
-
* @property { string } contextGroupId - Name of the context group.
|
|
7311
|
-
*/
|
|
7312
|
-
/**
|
|
7313
|
-
* @REMOVED
|
|
7314
|
-
* RemoveFromContextGroupOptions interface
|
|
7315
|
-
* @typedef { object } RemoveFromContextGroupOptions@typedef { object } RemoveFromContextGroupOptions
|
|
7316
|
-
* @property { Identity | ClientIdentity } target - Identity of the entity you wish to join to a context group.
|
|
7317
|
-
*/
|
|
7318
|
-
/**
|
|
7319
|
-
* @REMOVED
|
|
7320
|
-
* GetInfoForContextGroupOptions interface
|
|
7321
|
-
* @typedef { object } GetInfoForContextGroupOptions@typedef { object } GetInfoForContextGroupOptions
|
|
7322
|
-
* @property { string } contextGroupId - Name of the context group to get info for.
|
|
7323
|
-
*/
|
|
7324
|
-
/**
|
|
7325
|
-
* @REMOVED
|
|
7326
|
-
* GetAllClientsInContextGroupOptions interface
|
|
7327
|
-
* @typedef { object } GetAllClientsInContextGroupOptions@typedef { object } GetAllClientsInContextGroupOptions
|
|
7328
|
-
* @property { string } contextGroupId - Name of the context group to get info for.
|
|
7329
|
-
*/
|
|
7330
|
-
/**
|
|
7331
|
-
* @PORTED
|
|
7332
|
-
* InfoForIntentOptions interface
|
|
7333
|
-
* @typedef { object } InfoForIntentOptions@typedef { object } InfoForIntentOptions
|
|
7334
|
-
* @property { string } name Name of the intent to get info for.
|
|
7335
|
-
* @property { Context } [context] Optional context.
|
|
7336
|
-
*/
|
|
7337
7002
|
/**
|
|
7338
7003
|
* Sets a context for the context group of the incoming current entity.
|
|
7339
7004
|
* @param setContextOptions - New context to set.
|
|
@@ -7577,7 +7242,7 @@ declare class InteropBroker extends Base {
|
|
|
7577
7242
|
* // }
|
|
7578
7243
|
* ```
|
|
7579
7244
|
*
|
|
7580
|
-
* More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/
|
|
7245
|
+
* More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/Metadata#intentresolution).
|
|
7581
7246
|
*
|
|
7582
7247
|
* @param contextForIntent Data passed between entities and applications.
|
|
7583
7248
|
* @param clientIdentity Identity of the Client making the request.
|
|
@@ -7833,95 +7498,6 @@ declare type InteropBrokerOptions = {
|
|
|
7833
7498
|
logging?: InteropLoggingOptions;
|
|
7834
7499
|
};
|
|
7835
7500
|
|
|
7836
|
-
/**
|
|
7837
|
-
* @PORTED
|
|
7838
|
-
* @typedef { object } Intent
|
|
7839
|
-
* @summary The combination of an action and a context that is passed to an application for resolution.
|
|
7840
|
-
* @property { string } name Name of the intent.
|
|
7841
|
-
* @property { Context } context Data associated with the intent
|
|
7842
|
-
*/
|
|
7843
|
-
/**
|
|
7844
|
-
* @REMOVED
|
|
7845
|
-
* @typedef { object } Subscription
|
|
7846
|
-
* @summary Object returned when subscribing a handler.
|
|
7847
|
-
* @property { function } unsubscribe Function to unsubscribe the handler.
|
|
7848
|
-
*/
|
|
7849
|
-
/**
|
|
7850
|
-
* @typedef { function } ContextHandler
|
|
7851
|
-
* @summary Subscription function for addContextHandler.
|
|
7852
|
-
*/
|
|
7853
|
-
/**
|
|
7854
|
-
* @typedef { function } IntentHandler
|
|
7855
|
-
* @summary Subscription function for registerIntentHandler
|
|
7856
|
-
*/
|
|
7857
|
-
/**
|
|
7858
|
-
* @PORTED
|
|
7859
|
-
* @typedef { object } ClientIdentity
|
|
7860
|
-
* @summary The Identity for a Channel Client. Includes endpointId to differentiate between different connections for an entity.
|
|
7861
|
-
* @property {string} uuid GUID of an application.
|
|
7862
|
-
* @property {string} name Name of an entity in an application.
|
|
7863
|
-
* @property {string} endpointId Unique differentiator for different Channel connections for an entity.
|
|
7864
|
-
*/
|
|
7865
|
-
/**
|
|
7866
|
-
* @PORTED
|
|
7867
|
-
* @typedef { object } ContextGroupInfo
|
|
7868
|
-
* @summary Information for a Context Group. Contains metadata for displaying the group properly.
|
|
7869
|
-
* @property {string} id Name of the context group
|
|
7870
|
-
* @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.
|
|
7871
|
-
*/
|
|
7872
|
-
/**
|
|
7873
|
-
* @PORTED
|
|
7874
|
-
* @typedef { object } DisplayMetadata
|
|
7875
|
-
* @summary The display data for a Context Group.
|
|
7876
|
-
* @property {string} name A user-readable name for this context group, e.g: `"Red"`
|
|
7877
|
-
* @property {string} [color] The color that should be associated within this context group when displaying this context group in a UI, e.g: `0xFF0000`.
|
|
7878
|
-
* @property {string} [glyph] A URL of an image that can be used to display this context group
|
|
7879
|
-
*/
|
|
7880
|
-
/**
|
|
7881
|
-
* @PORTED
|
|
7882
|
-
* @typedef { object } Context
|
|
7883
|
-
* @summary Data passed between entities and applications.
|
|
7884
|
-
* @property {object} [id] An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
|
|
7885
|
-
* @property {string} [name] User-readable name for the incoming context.
|
|
7886
|
-
* @property {string} type Conserved type for the context (e.g. `instrument` or `country`)
|
|
7887
|
-
*/
|
|
7888
|
-
/**
|
|
7889
|
-
* @REMOVED
|
|
7890
|
-
* @typedef { object } ContextForIntent
|
|
7891
|
-
* @summary Data passed between entities and applications, including an optional metadata.
|
|
7892
|
-
* @property {object} [id] An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
|
|
7893
|
-
* @property {string} [name] User-readable name for the incoming context.
|
|
7894
|
-
* @property {string} type Conserved type for the context (e.g. `instrument` or `country`)
|
|
7895
|
-
* @property {any} [metadata]
|
|
7896
|
-
*/
|
|
7897
|
-
/**
|
|
7898
|
-
* @REMOVED
|
|
7899
|
-
* @typedef { object } SessionContextGroup
|
|
7900
|
-
* @summary An instance of a SessionContextGroup
|
|
7901
|
-
* @property {string} id The SessionContextGroup's id.
|
|
7902
|
-
* @property {setContext} setContext Sets a context of a certain type
|
|
7903
|
-
* @property {getCurrentContext} getCurrentContext Gets the currently set context of a certain type
|
|
7904
|
-
* @property {addContextHandler} addContextHandler Adds a handler for context change.
|
|
7905
|
-
*/
|
|
7906
|
-
/**
|
|
7907
|
-
* @typedef {function} setContext
|
|
7908
|
-
* @summary A SessionContextGroup instance method for setting a context in the SessionContextGroup.
|
|
7909
|
-
* @param context The Context to be set.
|
|
7910
|
-
*
|
|
7911
|
-
*/
|
|
7912
|
-
/**
|
|
7913
|
-
* @typedef {function} getCurrentContext
|
|
7914
|
-
* @summary A SessionContextGroup instance method for getting the current context of a certain type.
|
|
7915
|
-
* @param contextType The Context Type to get. If not specified the last contextType set would get used.
|
|
7916
|
-
*
|
|
7917
|
-
*/
|
|
7918
|
-
/**
|
|
7919
|
-
* @typedef {function} addContextHandler
|
|
7920
|
-
* @summary A SessionContextGroup instance method for adding a handler for context change.
|
|
7921
|
-
* @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.
|
|
7922
|
-
* @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.
|
|
7923
|
-
*
|
|
7924
|
-
*/
|
|
7925
7501
|
/**
|
|
7926
7502
|
* {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}
|
|
7927
7503
|
*
|
|
@@ -8360,13 +7936,6 @@ declare type InteropLoggingActions = 'beforeAction' | 'afterAction';
|
|
|
8360
7936
|
*/
|
|
8361
7937
|
declare type InteropLoggingOptions = Record<InteropLoggingActions, InteropActionLoggingOption>;
|
|
8362
7938
|
|
|
8363
|
-
/**
|
|
8364
|
-
* @PORTED
|
|
8365
|
-
* @typedef { object } InteropConfig
|
|
8366
|
-
* @summary Information relevant to the Interop Broker.
|
|
8367
|
-
* @property {string} [currentContextGroup] Context Group for the client. (green, yellow, red, etc.)
|
|
8368
|
-
* @property {string} [providerId] When provided, automatically connects the client to the specified provider uuid
|
|
8369
|
-
*/
|
|
8370
7939
|
/**
|
|
8371
7940
|
* Manages creation of Interop Brokers and Interop Clients. These APIs are called under-the-hood in Platforms.
|
|
8372
7941
|
*
|
|
@@ -8757,7 +8326,7 @@ declare class Layout extends Base {
|
|
|
8757
8326
|
* @internal
|
|
8758
8327
|
*/
|
|
8759
8328
|
init: (options?: OpenFin_2.InitLayoutOptions) => Promise<Layout>;
|
|
8760
|
-
identity: OpenFin_2.LayoutIdentity;
|
|
8329
|
+
identity: OpenFin_2.Identity | OpenFin_2.LayoutIdentity;
|
|
8761
8330
|
private platform;
|
|
8762
8331
|
wire: Transport;
|
|
8763
8332
|
/**
|
|
@@ -8976,45 +8545,24 @@ declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'r
|
|
|
8976
8545
|
*/
|
|
8977
8546
|
declare type LayoutIdentity = Identity_5 & {
|
|
8978
8547
|
/**
|
|
8979
|
-
* The name of the layout
|
|
8980
|
-
* OpenFin attempts to resolve the instance via visibility checks.
|
|
8548
|
+
* The name of the layout in a given window.
|
|
8981
8549
|
*/
|
|
8982
|
-
layoutName
|
|
8550
|
+
layoutName: string;
|
|
8983
8551
|
};
|
|
8984
8552
|
|
|
8985
8553
|
/**
|
|
8986
|
-
* Generated when
|
|
8554
|
+
* Generated when the window is created, and all of its layout's views have either finished or failed
|
|
8555
|
+
* navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
|
|
8987
8556
|
* @interface
|
|
8988
8557
|
*/
|
|
8989
8558
|
declare type LayoutInitializedEvent = BaseEvent_5 & {
|
|
8990
8559
|
type: 'layout-initialized';
|
|
8560
|
+
layoutIdentity: OpenFin_2.LayoutIdentity;
|
|
8991
8561
|
ofViews: (OpenFin_2.Identity & {
|
|
8992
8562
|
entityType: 'view';
|
|
8993
8563
|
})[];
|
|
8994
8564
|
};
|
|
8995
8565
|
|
|
8996
|
-
/**
|
|
8997
|
-
* @interface @experimental @internal
|
|
8998
|
-
*
|
|
8999
|
-
* **NOTE**: Internal use only. This type is reserved for Workspace Browser implementation.
|
|
9000
|
-
*
|
|
9001
|
-
* Responsible for handling all layout management and renderering
|
|
9002
|
-
*/
|
|
9003
|
-
declare type LayoutInstance = {
|
|
9004
|
-
identity: LayoutIdentity;
|
|
9005
|
-
getFrameSnapshot: () => Promise<LayoutOptions>;
|
|
9006
|
-
addView: (payload: AddViewOptions) => Promise<View_2>;
|
|
9007
|
-
closeView: (viewIdentity: Identity_5) => Promise<void>;
|
|
9008
|
-
removeView: (viewConfig: Identity_5 | ViewState) => Promise<View_2>;
|
|
9009
|
-
replaceView: (payload: ReplaceViewOptions) => Promise<View_2>;
|
|
9010
|
-
getViews: () => LayoutComponent[];
|
|
9011
|
-
getCurrentViews: () => Identity_5[];
|
|
9012
|
-
startReplaceLayout: (payload: ReplaceLayoutOptions) => Promise<void>;
|
|
9013
|
-
applyPreset: (payload: PresetLayoutOptions_2) => void;
|
|
9014
|
-
isVisible: () => boolean;
|
|
9015
|
-
destroy: () => Promise<void>;
|
|
9016
|
-
};
|
|
9017
|
-
|
|
9018
8566
|
/**
|
|
9019
8567
|
* Represents the arrangement of Views within a Platform window's Layout. We do not recommend trying
|
|
9020
8568
|
* to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot}.
|
|
@@ -9042,7 +8590,7 @@ declare type LayoutItemConfig = {
|
|
|
9042
8590
|
*
|
|
9043
8591
|
* **NOTE**: Internal use only. This type is reserved for Workspace Browser implementation.
|
|
9044
8592
|
*
|
|
9045
|
-
* Responsible for
|
|
8593
|
+
* Responsible for aggregating all layout snapshots and storing layout instances
|
|
9046
8594
|
*/
|
|
9047
8595
|
declare interface LayoutManager<T extends LayoutSnapshot> {
|
|
9048
8596
|
/**
|
|
@@ -9066,16 +8614,6 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
|
|
|
9066
8614
|
* @throws if Object.keys(snapshot).length > 1
|
|
9067
8615
|
*/
|
|
9068
8616
|
applyLayoutSnapshot(snapshot: T): Promise<void>;
|
|
9069
|
-
/**
|
|
9070
|
-
* Called at the start of layout initialization. Adds a new LayoutInstance if the snapshot
|
|
9071
|
-
* contains a single layout.
|
|
9072
|
-
*
|
|
9073
|
-
* Throws if the snapshot contains more than 1 layout, it is expected that the user handles calling
|
|
9074
|
-
* fin.Platform.Layout.create() once for each layout to properly connect it to their UI state.
|
|
9075
|
-
*
|
|
9076
|
-
* @param snapshot
|
|
9077
|
-
* @throws if Object.keys(snapshot).length > 1
|
|
9078
|
-
*/
|
|
9079
8617
|
/**
|
|
9080
8618
|
* @experimental
|
|
9081
8619
|
*
|
|
@@ -9096,31 +8634,49 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
|
|
|
9096
8634
|
/**
|
|
9097
8635
|
* @experimental
|
|
9098
8636
|
*
|
|
9099
|
-
*
|
|
9100
|
-
*
|
|
8637
|
+
* A hook provided to the consumer for controlling how OpenFin routes Layout API calls. Override
|
|
8638
|
+
* this method to control the target layout for Layout API calls.
|
|
8639
|
+
*
|
|
8640
|
+
* Example use case: You have hidden all the layouts and are showing a dialog that will
|
|
8641
|
+
* execute an API call (ex: Layout.replace()) - override this method and save the
|
|
8642
|
+
* "last visible" layout identity and return it.
|
|
8643
|
+
*
|
|
8644
|
+
* By default, OpenFin will use a series of checks to determine which Layout the API
|
|
8645
|
+
* call must route to in this order of precedence:
|
|
8646
|
+
* - try to resolve the layout from the layoutIdentity, throws if missing
|
|
8647
|
+
* - if there is only 1 layout, resolves that one
|
|
8648
|
+
* - enumerates all layouts checks visibility via element offsetTop/Left + window.innerHeight/Width
|
|
8649
|
+
* - returns undefined
|
|
8650
|
+
*
|
|
8651
|
+
* @param identity
|
|
8652
|
+
* @returns LayoutIdentity | undefined
|
|
9101
8653
|
*/
|
|
9102
|
-
|
|
8654
|
+
resolveLayoutIdentity(identity?: Identity_5 | LayoutIdentity): LayoutIdentity | undefined;
|
|
9103
8655
|
/**
|
|
9104
8656
|
* @experimental
|
|
9105
8657
|
*
|
|
9106
|
-
*
|
|
9107
|
-
*
|
|
9108
|
-
*
|
|
9109
|
-
*
|
|
8658
|
+
* A hook provided to the consumer when it's time to remove a layout. Use this hook to
|
|
8659
|
+
* update your local state and remove the layout for the given LayoutIdentity. Note that
|
|
8660
|
+
* this hook does not call `fin.Platform.Layout.destroy()` for you, instead it is to
|
|
8661
|
+
* signify to your application it's time to destroy this layout.
|
|
8662
|
+
*
|
|
8663
|
+
* Note that if the Window Option {@link WindowOptions.closeOnLastViewRemoved} is true, and the last View in this layout is closed, this hook will be called before the window closes.
|
|
8664
|
+
*
|
|
8665
|
+
* @param LayoutIdentity
|
|
9110
8666
|
*/
|
|
9111
|
-
|
|
8667
|
+
removeLayout({ layoutName }: LayoutIdentity): Promise<void>;
|
|
9112
8668
|
/**
|
|
9113
8669
|
* @experimental
|
|
9114
8670
|
*/
|
|
9115
|
-
|
|
8671
|
+
getLayoutIdentityForView(viewIdentity: Identity_5): LayoutIdentity;
|
|
9116
8672
|
/**
|
|
9117
8673
|
* @experimental
|
|
9118
8674
|
*/
|
|
9119
|
-
|
|
8675
|
+
isLayoutVisible({ layoutName }: LayoutIdentity): boolean;
|
|
9120
8676
|
/**
|
|
9121
8677
|
* @experimental
|
|
9122
8678
|
*/
|
|
9123
|
-
|
|
8679
|
+
size(): number;
|
|
9124
8680
|
}
|
|
9125
8681
|
|
|
9126
8682
|
/**
|
|
@@ -9167,7 +8723,7 @@ declare class LayoutModule extends Base {
|
|
|
9167
8723
|
* const layoutConfig = await layout.getConfig();
|
|
9168
8724
|
* ```
|
|
9169
8725
|
*/
|
|
9170
|
-
wrap(identity: OpenFin_2.LayoutIdentity): Promise<OpenFin_2.Layout>;
|
|
8726
|
+
wrap(identity: OpenFin_2.Identity | OpenFin_2.LayoutIdentity): Promise<OpenFin_2.Layout>;
|
|
9171
8727
|
/**
|
|
9172
8728
|
* Synchronously returns a Layout object that represents a Window's layout.
|
|
9173
8729
|
*
|
|
@@ -9187,7 +8743,7 @@ declare class LayoutModule extends Base {
|
|
|
9187
8743
|
* const layoutConfig = await layout.getConfig();
|
|
9188
8744
|
* ```
|
|
9189
8745
|
*/
|
|
9190
|
-
wrapSync(identity: OpenFin_2.LayoutIdentity): OpenFin_2.Layout;
|
|
8746
|
+
wrapSync(identity: OpenFin_2.Identity | OpenFin_2.LayoutIdentity): OpenFin_2.Layout;
|
|
9191
8747
|
/**
|
|
9192
8748
|
* Asynchronously returns a Layout object that represents a Window's layout.
|
|
9193
8749
|
*
|
|
@@ -9359,6 +8915,15 @@ declare abstract class LayoutNode {
|
|
|
9359
8915
|
/**
|
|
9360
8916
|
* Creates a new TabStack adjacent to the given TabStack or ColumnOrRow. Inputs can be new views to create, or existing views.
|
|
9361
8917
|
*
|
|
8918
|
+
* Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
|
|
8919
|
+
* during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
|
|
8920
|
+
* This means the views you pass to createAdjacentStack() may not render in the order given by the array.
|
|
8921
|
+
* Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
|
|
8922
|
+
*
|
|
8923
|
+
* @param views The views that will populate the new TabStack.
|
|
8924
|
+
* @param options Additional options that control new TabStack creation.
|
|
8925
|
+
* @returns The newly-created TabStack.
|
|
8926
|
+
*
|
|
9362
8927
|
* @example
|
|
9363
8928
|
* ```js
|
|
9364
8929
|
* if (!fin.me.isView) {
|
|
@@ -9393,12 +8958,15 @@ declare abstract class LayoutNode {
|
|
|
9393
8958
|
* console.log(`A new TabStack created to the right has ${newStack.length} views in it`);
|
|
9394
8959
|
*
|
|
9395
8960
|
* ```
|
|
8961
|
+
* @experimental
|
|
9396
8962
|
*/
|
|
9397
8963
|
createAdjacentStack: (views: OpenFin_2.PlatformViewCreationOptions[], options: {
|
|
9398
8964
|
position?: OpenFin_2.LayoutPosition;
|
|
9399
8965
|
}) => Promise<TabStack>;
|
|
9400
8966
|
/**
|
|
9401
|
-
* Retrieves the adjacent TabStacks of the given TabStack or ColumnOrRow
|
|
8967
|
+
* Retrieves the adjacent TabStacks of the given TabStack or ColumnOrRow.
|
|
8968
|
+
*
|
|
8969
|
+
* @param edge Edge whose adjacent TabStacks will be returned.
|
|
9402
8970
|
*
|
|
9403
8971
|
* @example
|
|
9404
8972
|
* ```js
|
|
@@ -9418,6 +8986,7 @@ declare abstract class LayoutNode {
|
|
|
9418
8986
|
* console.log(`The entity has ${rightStacks.length} stacks to the right, and ${leftStacks.length} stacks to the left`);
|
|
9419
8987
|
*
|
|
9420
8988
|
* ```
|
|
8989
|
+
* @experimental
|
|
9421
8990
|
*/
|
|
9422
8991
|
getAdjacentStacks: (edge: OpenFin_2.LayoutPosition) => Promise<TabStack[]>;
|
|
9423
8992
|
}
|
|
@@ -9441,7 +9010,7 @@ declare type LayoutOptions = {
|
|
|
9441
9010
|
* @defaultValue false
|
|
9442
9011
|
*
|
|
9443
9012
|
* Limits the area to which tabs can be dragged.
|
|
9444
|
-
* If true,
|
|
9013
|
+
* If true, the layout container is the only area where tabs can be dropped.
|
|
9445
9014
|
*/
|
|
9446
9015
|
constrainDragToContainer?: boolean;
|
|
9447
9016
|
/**
|
|
@@ -9512,6 +9081,9 @@ declare type LayoutOptions = {
|
|
|
9512
9081
|
};
|
|
9513
9082
|
};
|
|
9514
9083
|
|
|
9084
|
+
/**
|
|
9085
|
+
* Represents the position of an item in a layout relative to another.
|
|
9086
|
+
*/
|
|
9515
9087
|
declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
|
|
9516
9088
|
|
|
9517
9089
|
/**
|
|
@@ -9520,11 +9092,12 @@ declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
|
|
|
9520
9092
|
declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
|
|
9521
9093
|
|
|
9522
9094
|
/**
|
|
9523
|
-
* Generated when
|
|
9095
|
+
* Generated when the layout and all of the its views have been created and can receive API calls.
|
|
9524
9096
|
* @interface
|
|
9525
9097
|
*/
|
|
9526
9098
|
declare type LayoutReadyEvent = BaseEvent_5 & {
|
|
9527
9099
|
type: 'layout-ready';
|
|
9100
|
+
layoutIdentity: OpenFin_2.LayoutIdentity;
|
|
9528
9101
|
views: (OpenFin_2.Identity & {
|
|
9529
9102
|
success: boolean;
|
|
9530
9103
|
})[];
|
|
@@ -10237,7 +9810,7 @@ declare type MutableWindowOptions = {
|
|
|
10237
9810
|
* Used by Workspace to store custom data. Overwriting or modifying this field may impact the functionality of Workspace
|
|
10238
9811
|
*/
|
|
10239
9812
|
_internalWorkspaceData: any;
|
|
10240
|
-
workspacePlatform:
|
|
9813
|
+
workspacePlatform: unknown;
|
|
10241
9814
|
};
|
|
10242
9815
|
|
|
10243
9816
|
declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;
|
|
@@ -10323,7 +9896,7 @@ declare type NotCloseRequested<EventType extends string> = Exclude<EventType, 'c
|
|
|
10323
9896
|
*
|
|
10324
9897
|
* Ensures that an event type key doesn't include any `-requested` events. Distributes over unions.
|
|
10325
9898
|
*/
|
|
10326
|
-
declare type NotRequested<EventType extends String> = EventType extends `${
|
|
9899
|
+
declare type NotRequested<EventType extends String> = EventType extends `${string}-requested` ? never : EventType;
|
|
10327
9900
|
|
|
10328
9901
|
/**
|
|
10329
9902
|
* Generated when an application is not responding.
|
|
@@ -10435,6 +10008,7 @@ declare namespace OpenFin_2 {
|
|
|
10435
10008
|
ResizeRegion,
|
|
10436
10009
|
Accelerator,
|
|
10437
10010
|
Api,
|
|
10011
|
+
InjectionType,
|
|
10438
10012
|
NavigationRules,
|
|
10439
10013
|
ContentNavigation,
|
|
10440
10014
|
ContentRedirect,
|
|
@@ -10480,6 +10054,7 @@ declare namespace OpenFin_2 {
|
|
|
10480
10054
|
WebPermission,
|
|
10481
10055
|
VerboseWebPermission,
|
|
10482
10056
|
OpenExternalPermission,
|
|
10057
|
+
DeviceInfo,
|
|
10483
10058
|
Permissions_2 as Permissions,
|
|
10484
10059
|
PlatformWindowCreationOptions,
|
|
10485
10060
|
PlatformWindowOptions,
|
|
@@ -10637,7 +10212,6 @@ declare namespace OpenFin_2 {
|
|
|
10637
10212
|
InitLayoutOptions,
|
|
10638
10213
|
LayoutManagerConstructor,
|
|
10639
10214
|
LayoutManagerOverride,
|
|
10640
|
-
LayoutInstance,
|
|
10641
10215
|
LayoutManager,
|
|
10642
10216
|
CreateLayoutOptions,
|
|
10643
10217
|
PresetLayoutOptions_2 as PresetLayoutOptions,
|
|
@@ -10829,6 +10403,7 @@ declare type Permissions_2 = {
|
|
|
10829
10403
|
Application?: Partial<ApplicationPermissions>;
|
|
10830
10404
|
System?: Partial<SystemPermissions>;
|
|
10831
10405
|
webAPIs?: WebPermission[];
|
|
10406
|
+
devices?: DeviceInfo[];
|
|
10832
10407
|
};
|
|
10833
10408
|
|
|
10834
10409
|
declare type PermissionState_2 = 'granted' | 'denied' | 'unavailable';
|
|
@@ -11784,21 +11359,16 @@ declare interface PlatformProvider {
|
|
|
11784
11359
|
*/
|
|
11785
11360
|
getInitialLayoutSnapshot(payload: undefined, callerIdentity: OpenFin_2.Identity): Promise<OpenFin_2.LayoutSnapshot | undefined>;
|
|
11786
11361
|
/**
|
|
11787
|
-
* @experimental
|
|
11788
|
-
*
|
|
11789
|
-
* **NOTE**: Internal use only. This method is reserved for Workspace Browser implementation.
|
|
11790
|
-
*
|
|
11791
|
-
* Calls platform.createView for every view in the given layout. Returns an array of promises
|
|
11792
|
-
* one promise for each view create call
|
|
11362
|
+
* @experimental
|
|
11793
11363
|
*
|
|
11794
|
-
* @
|
|
11364
|
+
* This API is called during the {@link PlatformProvider.getSnapshot()} call.
|
|
11365
|
+
* Gets the current state of a particular window and its views and returns an object that
|
|
11366
|
+
* can be added to the {@link OpenFin.Snapshot.windows} property. Override this function if
|
|
11367
|
+
* you wish to mutate each window snapshot during the {@link PlatformProvider.getSnapshot()} call
|
|
11368
|
+
* @param identity
|
|
11795
11369
|
* @param callerIdentity
|
|
11796
|
-
* @returns an array of promises
|
|
11797
11370
|
*/
|
|
11798
|
-
|
|
11799
|
-
layout: GoldenLayout.Config;
|
|
11800
|
-
target?: OpenFin_2.Identity;
|
|
11801
|
-
}, callerIdentity: OpenFin_2.Identity): Promise<OpenFin_2.View>[];
|
|
11371
|
+
getWindowSnapshot(identity: OpenFin_2.Identity, callerIdentity: OpenFin_2.Identity): Promise<OpenFin_2.WindowCreationOptions>;
|
|
11802
11372
|
/**
|
|
11803
11373
|
* **NOTE**: Internal use only. It is not recommended to manage the state of individual views.
|
|
11804
11374
|
* Gets the current state of a single view and returns an object with the options needed to restore that view as part of a snapshot.
|
|
@@ -13262,7 +12832,7 @@ declare type ReplaceLayoutPayload = {
|
|
|
13262
12832
|
/**
|
|
13263
12833
|
* Identity of the window whose layout will be replaced.
|
|
13264
12834
|
*/
|
|
13265
|
-
target: LayoutIdentity;
|
|
12835
|
+
target: Identity_5 | LayoutIdentity;
|
|
13266
12836
|
};
|
|
13267
12837
|
|
|
13268
12838
|
/**
|
|
@@ -14099,83 +13669,6 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
14099
13669
|
*/
|
|
14100
13670
|
constructor(wire: Transport);
|
|
14101
13671
|
private sendExternalProcessRequest;
|
|
14102
|
-
/**
|
|
14103
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
|
14104
|
-
* @param eventType - The type of the event.
|
|
14105
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
|
14106
|
-
* @param options - Option to support event timestamps.
|
|
14107
|
-
*
|
|
14108
|
-
* @function addListener
|
|
14109
|
-
* @memberof System
|
|
14110
|
-
* @instance
|
|
14111
|
-
* @tutorial System.EventEmitter
|
|
14112
|
-
*/
|
|
14113
|
-
/**
|
|
14114
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
|
14115
|
-
* @param eventType - The type of the event.
|
|
14116
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
|
14117
|
-
* @param options - Option to support event timestamps.
|
|
14118
|
-
*
|
|
14119
|
-
* @function on
|
|
14120
|
-
* @memberof System
|
|
14121
|
-
* @instance
|
|
14122
|
-
* @tutorial System.EventEmitter
|
|
14123
|
-
*/
|
|
14124
|
-
/**
|
|
14125
|
-
* 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.
|
|
14126
|
-
* @param eventType - The type of the event.
|
|
14127
|
-
* @param listener - The callback function.
|
|
14128
|
-
* @param options - Option to support event timestamps.
|
|
14129
|
-
*
|
|
14130
|
-
* @function once
|
|
14131
|
-
* @memberof System
|
|
14132
|
-
* @instance
|
|
14133
|
-
* @tutorial System.EventEmitter
|
|
14134
|
-
*/
|
|
14135
|
-
/**
|
|
14136
|
-
* Adds a listener to the beginning of the listeners array for the specified event.
|
|
14137
|
-
* @param eventType - The type of the event.
|
|
14138
|
-
* @param listener - The callback function.
|
|
14139
|
-
* @param options - Option to support event timestamps.
|
|
14140
|
-
*
|
|
14141
|
-
* @function prependListener
|
|
14142
|
-
* @memberof System
|
|
14143
|
-
* @instance
|
|
14144
|
-
* @tutorial System.EventEmitter
|
|
14145
|
-
*/
|
|
14146
|
-
/**
|
|
14147
|
-
* 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.
|
|
14148
|
-
* The listener is added to the beginning of the listeners array.
|
|
14149
|
-
* @param eventType - The type of the event.
|
|
14150
|
-
* @param listener - The callback function.
|
|
14151
|
-
* @param options - Option to support event timestamps.
|
|
14152
|
-
*
|
|
14153
|
-
* @function prependOnceListener
|
|
14154
|
-
* @memberof System
|
|
14155
|
-
* @instance
|
|
14156
|
-
* @tutorial System.EventEmitter
|
|
14157
|
-
*/
|
|
14158
|
-
/**
|
|
14159
|
-
* Remove a listener from the listener array for the specified event.
|
|
14160
|
-
* Caution: Calling this method changes the array indices in the listener array behind the listener.
|
|
14161
|
-
* @param eventType - The type of the event.
|
|
14162
|
-
* @param listener - The callback function.
|
|
14163
|
-
* @param options - Option to support event timestamps.
|
|
14164
|
-
*
|
|
14165
|
-
* @function removeListener
|
|
14166
|
-
* @memberof System
|
|
14167
|
-
* @instance
|
|
14168
|
-
* @tutorial System.EventEmitter
|
|
14169
|
-
*/
|
|
14170
|
-
/**
|
|
14171
|
-
* Removes all listeners, or those of the specified event.
|
|
14172
|
-
* @param eventType - The type of the event.
|
|
14173
|
-
*
|
|
14174
|
-
* @function removeAllListeners
|
|
14175
|
-
* @memberof System
|
|
14176
|
-
* @instance
|
|
14177
|
-
* @tutorial System.EventEmitter
|
|
14178
|
-
*/
|
|
14179
13672
|
/**
|
|
14180
13673
|
* Returns the version of the runtime. The version contains the major, minor,
|
|
14181
13674
|
* build and revision numbers.
|
|
@@ -15765,77 +15258,13 @@ declare interface TabDragListener extends EventEmitter_2 {
|
|
|
15765
15258
|
contentItem: ContentItem;
|
|
15766
15259
|
}
|
|
15767
15260
|
|
|
15768
|
-
/**
|
|
15769
|
-
* @typedef {string} LayoutPosition
|
|
15770
|
-
* @summary Represents the position of an item in a layout relative to another. Possible values are 'top', 'bottom', 'left' and 'right'.
|
|
15771
|
-
*/
|
|
15772
|
-
/**
|
|
15773
|
-
* @typedef {object} StackCreationOptions
|
|
15774
|
-
* @summary Stack creation options.
|
|
15775
|
-
* @property {LayoutPosition} [position] - The position to create the new {@link TabStack} in, relative to the given adjacent {@link TabStack}. Defaults to 'right'.
|
|
15776
|
-
*/
|
|
15777
|
-
/**
|
|
15778
|
-
* @typedef {object} TabStack~AddViewOptions
|
|
15779
|
-
* @summary Options to use when adding a view to a {@link TabStack}
|
|
15780
|
-
* @property {number} [index] - Insertion index when adding the view. Defaults to 0.
|
|
15781
|
-
*/
|
|
15782
15261
|
/**
|
|
15783
15262
|
* A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
|
|
15784
15263
|
*/
|
|
15785
15264
|
declare class TabStack extends LayoutNode {
|
|
15786
15265
|
#private;
|
|
15787
|
-
/**
|
|
15788
|
-
|
|
15789
|
-
* @function isRoot
|
|
15790
|
-
* @memberof TabStack
|
|
15791
|
-
* @instance
|
|
15792
|
-
* @tutorial TabStack.isRoot
|
|
15793
|
-
* @returns Resolves true if this TabStack is the top level content item, or false if it is not.
|
|
15794
|
-
*/
|
|
15795
|
-
/**
|
|
15796
|
-
* Determines if this {@link TabStack} exists.
|
|
15797
|
-
* @function exists
|
|
15798
|
-
* @instance
|
|
15799
|
-
* @memberof TabStack
|
|
15800
|
-
* @tutorial TabStack.exists
|
|
15801
|
-
* @returns Resolves true if this is the TabStack exists, or false if it has been destroyed.
|
|
15802
|
-
*/
|
|
15803
|
-
/**
|
|
15804
|
-
* Retrieves the parent {@link ColumnOrRow} of this {@link TabStack}, if one exists.
|
|
15805
|
-
* @function getParent
|
|
15806
|
-
* @instance
|
|
15807
|
-
* @memberof TabStack
|
|
15808
|
-
* @tutorial TabStack.getParent
|
|
15809
|
-
* @returns is the root content item or does not exist.
|
|
15810
|
-
*/
|
|
15811
|
-
/**
|
|
15812
|
-
* Returns all the adjacent stacks that share an edge with the given {@link TabStack}.
|
|
15813
|
-
* @function getAdjacentStacks
|
|
15814
|
-
* @instance
|
|
15815
|
-
* @memberof TabStack
|
|
15816
|
-
* @param {LayoutPosition} edge - Edge to check for any adjacent stacks.
|
|
15817
|
-
*
|
|
15818
|
-
* @tutorial TabStack.getAdjacentStacks
|
|
15819
|
-
*/
|
|
15820
|
-
/**
|
|
15821
|
-
* Given a list of view creation options or references and a layout position, creates a {@link TabStack} adjacent to the current {@link TabStack}
|
|
15822
|
-
*
|
|
15823
|
-
* Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
|
|
15824
|
-
* during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
|
|
15825
|
-
* This means the views you pass to createAdjacentStack() may not render in the order given by the array.
|
|
15826
|
-
* Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
|
|
15827
|
-
*
|
|
15828
|
-
* @function createAdjacentStack
|
|
15829
|
-
* @instance
|
|
15830
|
-
* @memberof TabStack
|
|
15831
|
-
* @param views - List of identities or view creation options of the views to include in the stack
|
|
15832
|
-
* @param options - Creation options.
|
|
15833
|
-
* @returns The created TabStack.
|
|
15834
|
-
* @tutorial TabStack.createAdjacentStack
|
|
15835
|
-
* @experimental
|
|
15836
|
-
*/
|
|
15837
|
-
/** @internal */
|
|
15838
|
-
constructor(client: LayoutEntitiesClient, entityId: string);
|
|
15266
|
+
/** @internal */
|
|
15267
|
+
constructor(client: LayoutEntitiesClient, entityId: string);
|
|
15839
15268
|
/**
|
|
15840
15269
|
* Type of the content item. Always stack, but useful for distinguishing between a {@link TabStack} and {@link ColumnOrRow}.
|
|
15841
15270
|
*/
|
|
@@ -16274,169 +15703,6 @@ declare type VerboseWebPermission = {
|
|
|
16274
15703
|
|
|
16275
15704
|
declare type View = OpenFin_2.View;
|
|
16276
15705
|
|
|
16277
|
-
/**
|
|
16278
|
-
* @PORTED
|
|
16279
|
-
* @typedef {object} View~options
|
|
16280
|
-
* @summary View creation options.
|
|
16281
|
-
* @desc This is the options object required by {@link View.create View.create}.
|
|
16282
|
-
*
|
|
16283
|
-
* Note that `name` and `target` are the only required properties — albeit the `url` property is usually provided as well
|
|
16284
|
-
* (defaults to `"about:blank"` when omitted).
|
|
16285
|
-
*
|
|
16286
|
-
* @property {object} [experimental]
|
|
16287
|
-
* Configurations for API injection.
|
|
16288
|
-
*
|
|
16289
|
-
* @property {boolean} [experimental.childWindows] Configure if the runtime should enable child windows for views.
|
|
16290
|
-
*
|
|
16291
|
-
* @property {object} [accelerator]
|
|
16292
|
-
* Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
|
|
16293
|
-
*
|
|
16294
|
-
* @property {boolean} [accelerator.devtools=false]
|
|
16295
|
-
* If `true`, enables the devtools keyboard shortcut:<br>
|
|
16296
|
-
* `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
|
|
16297
|
-
*
|
|
16298
|
-
* @property {boolean} [accelerator.reload=false]
|
|
16299
|
-
* If `true`, enables the reload keyboard shortcuts:<br>
|
|
16300
|
-
* `Ctrl` + `R` _(Windows)_<br>
|
|
16301
|
-
* `F5` _(Windows)_<br>
|
|
16302
|
-
* `Command` + `R` _(Mac)_
|
|
16303
|
-
*
|
|
16304
|
-
* @property {boolean} [accelerator.reloadIgnoringCache=false]
|
|
16305
|
-
* If `true`, enables the reload-from-source keyboard shortcuts:<br>
|
|
16306
|
-
* `Ctrl` + `Shift` + `R` _(Windows)_<br>
|
|
16307
|
-
* `Shift` + `F5` _(Windows)_<br>
|
|
16308
|
-
* `Command` + `Shift` + `R` _(Mac)_
|
|
16309
|
-
*
|
|
16310
|
-
* @property {boolean} [accelerator.zoom=false]
|
|
16311
|
-
* If `true`, enables the zoom keyboard shortcuts:<br>
|
|
16312
|
-
* `Ctrl` + `+` _(Zoom In)_<br>
|
|
16313
|
-
* `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
|
|
16314
|
-
* `Ctrl` + `NumPad+` _(Zoom In)_<br>
|
|
16315
|
-
* `Ctrl` + `-` _(Zoom Out)_<br>
|
|
16316
|
-
* `Ctrl` + `Shift` + `-` _(Zoom Out)_<br>
|
|
16317
|
-
* `Ctrl` + `NumPad-` _(Zoom Out)_<br>
|
|
16318
|
-
* `Ctrl` + `Scroll` _(Zoom In & Out)_<br>
|
|
16319
|
-
* `Ctrl` + `0` _(Restore to 100%)_
|
|
16320
|
-
*
|
|
16321
|
-
* @property {object} [api]
|
|
16322
|
-
* Configurations for API injection.
|
|
16323
|
-
*
|
|
16324
|
-
* @property {object} [api.iframe] Configure if the the API should be injected into iframes based on domain.
|
|
16325
|
-
*
|
|
16326
|
-
* @property {boolean} [api.iframe.crossOriginInjection=false] Controls if the `fin` API object is present for cross origin iframes.
|
|
16327
|
-
* @property {boolean} [api.iframe.sameOriginInjection=true] Controls if the `fin` API object is present for same origin iframes.
|
|
16328
|
-
*
|
|
16329
|
-
* @property {string} [autoplayPolicy="no-user-gesture-required"]
|
|
16330
|
-
* Autoplay policy to apply to content in the window, can be
|
|
16331
|
-
* `no-user-gesture-required`, `user-gesture-required`,
|
|
16332
|
-
* `document-user-activation-required`. Defaults to `no-user-gesture-required`.
|
|
16333
|
-
*
|
|
16334
|
-
* @property {object} [autoResize] AutoResize options
|
|
16335
|
-
*
|
|
16336
|
-
* @property {object} [bounds] initial bounds given relative to the window.
|
|
16337
|
-
*
|
|
16338
|
-
* @property {string} [backgroundColor="#FFF"] - _Updatable._
|
|
16339
|
-
* The view’s _backfill_ color as a hexadecimal value. Not to be confused with the content background color
|
|
16340
|
-
* (`document.body.style.backgroundColor`),
|
|
16341
|
-
* this color briefly fills a view’s (a) content area before its content is loaded as well as (b) newly exposed
|
|
16342
|
-
* areas when growing a window. Setting
|
|
16343
|
-
* this value to the anticipated content background color can help improve user experience.
|
|
16344
|
-
* Default is white.
|
|
16345
|
-
*
|
|
16346
|
-
* @property {object} [contentNavigation]
|
|
16347
|
-
* Restrict navigation to URLs that match an allowed pattern.
|
|
16348
|
-
* In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
|
|
16349
|
-
* See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
|
|
16350
|
-
* @property {string[]} [contentNavigation.allowlist=[]] List of allowed URLs.
|
|
16351
|
-
* @property {string[]} [contentNavigation.denylist=[]] List of denied URLs.
|
|
16352
|
-
*
|
|
16353
|
-
* @property {object} [contentRedirect]
|
|
16354
|
-
* Restrict redirects to URLs that match an allowed pattern.
|
|
16355
|
-
* In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
|
|
16356
|
-
* See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
|
|
16357
|
-
* @property {string[]} [contentRedirect.allowlist=[]] List of allowed URLs.
|
|
16358
|
-
* @property {string[]} [contentRedirect.denylist=[]] List of denied URLs.
|
|
16359
|
-
*
|
|
16360
|
-
* @property {object} [contextMenuSettings] - _Updatable._
|
|
16361
|
-
* Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
|
|
16362
|
-
* Configure the context menu when right-clicking on a view.
|
|
16363
|
-
* @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
|
|
16364
|
-
* @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
|
|
16365
|
-
* @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
|
|
16366
|
-
*
|
|
16367
|
-
* @property {object} [contextMenuOptions] - _Updatable._
|
|
16368
|
-
* Configure the context menu when right-clicking on a view. Supported menu items:
|
|
16369
|
-
* 'separator'
|
|
16370
|
-
* 'cut'
|
|
16371
|
-
* 'copy'
|
|
16372
|
-
* 'copyImage',
|
|
16373
|
-
* 'paste'
|
|
16374
|
-
* 'spellCheck'
|
|
16375
|
-
* 'inspect'
|
|
16376
|
-
* 'reload'
|
|
16377
|
-
* 'navigateForward'
|
|
16378
|
-
* 'navigateBack'
|
|
16379
|
-
* 'print'
|
|
16380
|
-
* @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
|
|
16381
|
-
* @property {string[]} [contextMenuOptions.template=[]] List of context menu items to display on right-click.
|
|
16382
|
-
*
|
|
16383
|
-
* @property {any} [customData=""] - _Updatable._
|
|
16384
|
-
* A field that the user can attach serializable data to be ferried around with the view options.
|
|
16385
|
-
* _When omitted, the default value of this property is the empty string (`""`)._
|
|
16386
|
-
*
|
|
16387
|
-
* @property {any} [customContext=""] - _Updatable._
|
|
16388
|
-
* A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
|
|
16389
|
-
* is called.
|
|
16390
|
-
* When omitted, the default value of this property is the empty string (`""`).
|
|
16391
|
-
* As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
|
|
16392
|
-
*
|
|
16393
|
-
* @property {object[]} [hotkeys=[]] - _Updatable._
|
|
16394
|
-
* Defines the list of hotkeys that will be emitted as a `hotkey` event on the view. For usage example see [example]{@tutorial hotkeys}.
|
|
16395
|
-
* Within Platform, OpenFin also implements a set of pre-defined actions called
|
|
16396
|
-
* [keyboard commands]{@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands}
|
|
16397
|
-
* that can be assigned to a specific hotkey in the platform manifest.
|
|
16398
|
-
* @property {string} hotkeys.keys The key combination of the hotkey, i.e. "Ctrl+T"
|
|
16399
|
-
* @property {boolean} [hotkeys.preventDefault=false] preventDefault will prevent the page keydown/keyup events from being emitted.
|
|
16400
|
-
*
|
|
16401
|
-
* @property {boolean} [isClosable=true] **Platforms Only.** If false, the view will be persistent and can't be closed through
|
|
16402
|
-
* either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
|
|
16403
|
-
* if the view isn't part of the new layout when running `Layout.replace`.
|
|
16404
|
-
*
|
|
16405
|
-
* @property {string} name
|
|
16406
|
-
* The name of the view.
|
|
16407
|
-
*
|
|
16408
|
-
* @property {boolean} [detachOnClose=false] - _Updatable._
|
|
16409
|
-
* Platforms Only. If true, will hide and detach the View from the window for later use instead of closing,
|
|
16410
|
-
* allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
|
|
16411
|
-
*
|
|
16412
|
-
* @property {string} [manifestUrl] **Platforms Only.** Url to a manifest that contains View Options. Properties other than manifestUrl can still be used
|
|
16413
|
-
* but the properties in the manifest will take precedence if there is any collision.
|
|
16414
|
-
*
|
|
16415
|
-
* @property {preloadScript[]} [preloadScripts] - _Inheritable_
|
|
16416
|
-
* A list of scripts that are eval'ed before other scripts in the page. When omitted, _inherits_
|
|
16417
|
-
* from the parent application.
|
|
16418
|
-
*
|
|
16419
|
-
* @property {boolean} [preventDragOut=false] **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
|
|
16420
|
-
*
|
|
16421
|
-
* @property {string} [processAffinity=<application uuid>]
|
|
16422
|
-
* A string to attempt to group renderers together. Will only be used if pages are on the same origin.
|
|
16423
|
-
*
|
|
16424
|
-
* @property {boolean} [spellCheck=false]
|
|
16425
|
-
* Enable spell check in input text fields for the view.
|
|
16426
|
-
*
|
|
16427
|
-
* @property {Identity} [target]
|
|
16428
|
-
* The identity of the window this view should be attached to.
|
|
16429
|
-
*
|
|
16430
|
-
* @property {string} [url="about:blank"]
|
|
16431
|
-
* The URL of the view.
|
|
16432
|
-
*
|
|
16433
|
-
* @property {string} [uuid=<application uuid>]
|
|
16434
|
-
* The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
|
|
16435
|
-
* If omitted, defaults to the `uuid` of the application spawning the view.
|
|
16436
|
-
* If given, must match the `uuid` of the application spawning the view.
|
|
16437
|
-
* In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
|
|
16438
|
-
* really no need to provide it.
|
|
16439
|
-
*/
|
|
16440
15706
|
/**
|
|
16441
15707
|
* A View can be used to embed additional web content into a Window.
|
|
16442
15708
|
* It is like a child window, except it is positioned relative to its owning window.
|
|
@@ -16952,7 +16218,7 @@ declare type ViewCreationOrReference = OpenFin_2.Identity | OpenFin_2.PlatformVi
|
|
|
16952
16218
|
*/
|
|
16953
16219
|
declare type ViewDetachedEvent = BaseEvent_5 & {
|
|
16954
16220
|
type: 'view-detached';
|
|
16955
|
-
target: OpenFin_2.Identity;
|
|
16221
|
+
target: OpenFin_2.Identity | null;
|
|
16956
16222
|
previousTarget: OpenFin_2.Identity;
|
|
16957
16223
|
viewIdentity: OpenFin_2.Identity;
|
|
16958
16224
|
};
|
|
@@ -18188,7 +17454,7 @@ declare namespace WebContentsEvents {
|
|
|
18188
17454
|
* `clipboard-read`: Request access to read from the clipboard.<br>
|
|
18189
17455
|
* `clipboard-sanitized-write`: Request access to write to the clipboard.
|
|
18190
17456
|
*/
|
|
18191
|
-
declare type WebPermission = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write' | OpenExternalPermission;
|
|
17457
|
+
declare type WebPermission = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write' | 'hid' | 'usb' | OpenExternalPermission;
|
|
18192
17458
|
|
|
18193
17459
|
/**
|
|
18194
17460
|
* Object representing headers and their values, where the
|
|
@@ -18266,476 +17532,6 @@ declare type WillResizeEvent = WillMoveOrResizeEvent & {
|
|
|
18266
17532
|
type: 'will-resize';
|
|
18267
17533
|
};
|
|
18268
17534
|
|
|
18269
|
-
/**
|
|
18270
|
-
* @PORTED
|
|
18271
|
-
* @typedef { object } Margins@typedef { object } Margins
|
|
18272
|
-
* @property { string } [marginType]
|
|
18273
|
-
* Can be `default`, `none`, `printableArea`, or `custom`. If `custom` is chosen,
|
|
18274
|
-
* you will also need to specify `top`, `bottom`, `left`, and `right`.
|
|
18275
|
-
*
|
|
18276
|
-
* @property { number } [top] The top margin of the printed web page, in pixels.
|
|
18277
|
-
* @property { number } [bottom] The bottom margin of the printed web page, in pixels.
|
|
18278
|
-
* @property { number } [left] The left margin of the printed web page, in pixels.
|
|
18279
|
-
* @property { number } [right] The right margin of the printed web page, in pixels.
|
|
18280
|
-
*/
|
|
18281
|
-
/**
|
|
18282
|
-
* @PORTED
|
|
18283
|
-
* @typedef { object } Dpi@typedef { object } Dpi
|
|
18284
|
-
* @property { number } [horizontal] The horizontal dpi
|
|
18285
|
-
* @property { number } [vertical] The vertical dpi
|
|
18286
|
-
*/
|
|
18287
|
-
/**
|
|
18288
|
-
* @PORTED
|
|
18289
|
-
* @typedef { object } PrintOptions@typedef { object } PrintOptions
|
|
18290
|
-
* @property { boolean } [silent=false] Don't ask user for print settings.
|
|
18291
|
-
* @property { boolean } [printBackground=false] Prints the background color and image of the web page.
|
|
18292
|
-
* @property { string } [deviceName=''] Set the printer device name to use.
|
|
18293
|
-
* @property { boolean } [color=true] Set whether the printed web page will be in color or grayscale.
|
|
18294
|
-
* @property { Margins } [margins] Set margins for the printed web page
|
|
18295
|
-
* @property { boolean } [landscape=false] Whether the web page should be printed in landscape mode.
|
|
18296
|
-
* @property { number } [scaleFactor] The scale factor of the web page.
|
|
18297
|
-
* @property { number } [pagesPerSheet] The number of pages to print per page sheet.
|
|
18298
|
-
* @property { boolean } [collate] Whether the web page should be collated.
|
|
18299
|
-
* @property { number } [copies] The number of copies of the web page to print.
|
|
18300
|
-
* @property { Record<string, number> } [pageRanges] The page range to print. Should have two keys: from and to.
|
|
18301
|
-
* @property { string } [duplexMode] Set the duplex mode of the printed web page. Can be simplex, shortEdge, or longEdge.
|
|
18302
|
-
* @property { Dpi } [dpi] Set dpi for the printed web page
|
|
18303
|
-
*/
|
|
18304
|
-
/**
|
|
18305
|
-
* @REMOVED
|
|
18306
|
-
* PrinterInfo interface
|
|
18307
|
-
* @typedef { object } PrinterInfo@typedef { object } PrinterInfo
|
|
18308
|
-
* @property { string } name Printer Name
|
|
18309
|
-
* @property { string } description Printer Description
|
|
18310
|
-
* @property { number } status Printer Status
|
|
18311
|
-
* @property { boolean } isDefault Indicates that system's default printer
|
|
18312
|
-
*/
|
|
18313
|
-
/**
|
|
18314
|
-
* @REMOVED
|
|
18315
|
-
* SharedWorkerInfo interface
|
|
18316
|
-
* @typedef { object } SharedWorkerInfo@typedef { object } SharedWorkerInfo
|
|
18317
|
-
* @property { string } id The unique id of the shared worker.
|
|
18318
|
-
* @property { string } url The url of the shared worker.
|
|
18319
|
-
*/
|
|
18320
|
-
/**
|
|
18321
|
-
* @PORTED
|
|
18322
|
-
* ContentCreationRule interface
|
|
18323
|
-
* @typedef { object } ContentCreationRule@typedef { object } ContentCreationRule
|
|
18324
|
-
* @property { string } behavior 'view' | 'window' | 'browser' | 'block'
|
|
18325
|
-
* @property { string[] } match List of [match patterns](https://developer.chrome.com/extensions/match_patterns).
|
|
18326
|
-
* @property { object } options Window creation options or View creation options.
|
|
18327
|
-
*/
|
|
18328
|
-
/**
|
|
18329
|
-
* @PORTED
|
|
18330
|
-
* @typedef {object} Window~options
|
|
18331
|
-
* @summary Window creation options.
|
|
18332
|
-
* @desc This is the options object required by {@link Window.create Window.create}.
|
|
18333
|
-
*
|
|
18334
|
-
* Note that `name` is the only required property — albeit the `url` property is usually provided as well
|
|
18335
|
-
* (defaults to `"about:blank"` when omitted).
|
|
18336
|
-
*
|
|
18337
|
-
* _This jsdoc typedef mirrors the `WindowOptions` TypeScript interface in `@types/openfin`._
|
|
18338
|
-
*
|
|
18339
|
-
* @property {object} [accelerator]
|
|
18340
|
-
* Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
|
|
18341
|
-
*
|
|
18342
|
-
* @property {boolean} [accelerator.devtools=false]
|
|
18343
|
-
* If `true`, enables the devtools keyboard shortcut:<br>
|
|
18344
|
-
* `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
|
|
18345
|
-
*
|
|
18346
|
-
* @property {boolean} [accelerator.reload=false]
|
|
18347
|
-
* If `true`, enables the reload keyboard shortcuts:<br>
|
|
18348
|
-
* `Ctrl` + `R` _(Windows)_<br>
|
|
18349
|
-
* `F5` _(Windows)_<br>
|
|
18350
|
-
* `Command` + `R` _(Mac)_
|
|
18351
|
-
*
|
|
18352
|
-
* @property {boolean} [accelerator.reloadIgnoringCache=false]
|
|
18353
|
-
* If `true`, enables the reload-from-source keyboard shortcuts:<br>
|
|
18354
|
-
* `Ctrl` + `Shift` + `R` _(Windows)_<br>
|
|
18355
|
-
* `Shift` + `F5` _(Windows)_<br>
|
|
18356
|
-
* `Command` + `Shift` + `R` _(Mac)_
|
|
18357
|
-
*
|
|
18358
|
-
* @property {boolean} [accelerator.zoom=false]
|
|
18359
|
-
* 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.
|
|
18360
|
-
* If `true`, enables the zoom keyboard shortcuts:<br>
|
|
18361
|
-
* `Ctrl` + `+` _(Zoom In)_<br>
|
|
18362
|
-
* `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
|
|
18363
|
-
* `Ctrl` + `NumPad+` _(Zoom In)_<br>
|
|
18364
|
-
* `Ctrl` + `-` _(Zoom Out)_<br>
|
|
18365
|
-
* `Ctrl` + `Shift` + `-` _(Zoom Out)_<br>
|
|
18366
|
-
* `Ctrl` + `NumPad-` _(Zoom Out)_<br>
|
|
18367
|
-
* `Ctrl` + `Scroll` _(Zoom In & Out)_<br>
|
|
18368
|
-
* `Ctrl` + `0` _(Restore to 100%)_
|
|
18369
|
-
*
|
|
18370
|
-
* @property {object} [alphaMask] - _Experimental._ _Updatable._
|
|
18371
|
-
* <br>
|
|
18372
|
-
* alphaMask turns anything of matching RGB value transparent.
|
|
18373
|
-
* <br>
|
|
18374
|
-
* Caveats:
|
|
18375
|
-
* * Runtime flags --disable-gpu and --allow-unsafe-compositing are required. Note: Unclear behavior on remote Desktop support
|
|
18376
|
-
* * User cannot click-through transparent regions
|
|
18377
|
-
* * Not supported on Mac
|
|
18378
|
-
* * Windows Aero must be enabled
|
|
18379
|
-
* * Won't make visual sense on Pixel-pushed environments such as Citrix
|
|
18380
|
-
* * Not supported on rounded corner windows
|
|
18381
|
-
* @property {number} [alphaMask.red=-1] 0-255
|
|
18382
|
-
* @property {number} [alphaMask.green=-1] 0-255
|
|
18383
|
-
* @property {number} [alphaMask.blue=-1] 0-255
|
|
18384
|
-
*
|
|
18385
|
-
* @property {boolean} [alwaysOnTop=false] - _Updatable._
|
|
18386
|
-
* A flag to always position the window at the top of the window stack.
|
|
18387
|
-
*
|
|
18388
|
-
* @property {object} [api]
|
|
18389
|
-
* Configurations for API injection.
|
|
18390
|
-
*
|
|
18391
|
-
* @property {object} [api.iframe] Configure if the the API should be injected into iframes based on domain.
|
|
18392
|
-
*
|
|
18393
|
-
* @property {boolean} [api.iframe.crossOriginInjection=false] Controls if the `fin` API object is present for cross origin iframes.
|
|
18394
|
-
* @property {boolean} [api.iframe.sameOriginInjection=true] Controls if the `fin` API object is present for same origin iframes.
|
|
18395
|
-
*
|
|
18396
|
-
* @property {string} [applicationIcon = ""] - _Deprecated_ - use `icon` instead.
|
|
18397
|
-
*
|
|
18398
|
-
* @property {number} [aspectRatio=0] - _Updatable._
|
|
18399
|
-
* The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
|
|
18400
|
-
* an aspect ratio will not be enforced.
|
|
18401
|
-
*
|
|
18402
|
-
* @property {string} [autoplayPolicy="no-user-gesture-required"]
|
|
18403
|
-
* Autoplay policy to apply to content in the window, can be
|
|
18404
|
-
* `no-user-gesture-required`, `user-gesture-required`,
|
|
18405
|
-
* `document-user-activation-required`. Defaults to `no-user-gesture-required`.
|
|
18406
|
-
*
|
|
18407
|
-
* @property {boolean} [autoShow=true]
|
|
18408
|
-
* A flag to automatically show the window when it is created.
|
|
18409
|
-
*
|
|
18410
|
-
* @property {string} [backgroundColor="#FFF"]
|
|
18411
|
-
* The window’s _backfill_ color as a hexadecimal value. Not to be confused with the content background color
|
|
18412
|
-
* (`document.body.style.backgroundColor`),
|
|
18413
|
-
* this color briefly fills a window’s (a) content area before its content is loaded as well as (b) newly exposed
|
|
18414
|
-
* areas when growing a window. Setting
|
|
18415
|
-
* this value to the anticipated content background color can help improve user experience.
|
|
18416
|
-
* Default is white.
|
|
18417
|
-
*
|
|
18418
|
-
* @property {object} [contentCreation]
|
|
18419
|
-
* Apply rules that determine how user interaction (`window.open` and links) creates content.
|
|
18420
|
-
* @property {ContentCreationRule[]} [contentCreation.rules = []] List of content creation rules.
|
|
18421
|
-
*
|
|
18422
|
-
* @property {object} [contentNavigation]
|
|
18423
|
-
* Restrict navigation to URLs that match an allowed pattern.
|
|
18424
|
-
* In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
|
|
18425
|
-
* See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
|
|
18426
|
-
* @property {string[]} [contentNavigation.allowlist=[]] List of allowed URLs.
|
|
18427
|
-
* @property {string[]} [contentNavigation.denylist=[]] List of denied URLs.
|
|
18428
|
-
*
|
|
18429
|
-
* @property {object} [contentRedirect]
|
|
18430
|
-
* Restrict redirects to URLs that match an allowed pattern.
|
|
18431
|
-
* In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
|
|
18432
|
-
* See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
|
|
18433
|
-
* @property {string[]} [contentRedirect.allowlist=[]] List of allowed URLs.
|
|
18434
|
-
* @property {string[]} [contentRedirect.denylist=[]] List of denied URLs.
|
|
18435
|
-
*
|
|
18436
|
-
* @property {boolean} [contextMenu=true] - _Updatable._
|
|
18437
|
-
* A flag to show the context menu when right-clicking on a window.
|
|
18438
|
-
* Gives access to the devtools for the window.
|
|
18439
|
-
*
|
|
18440
|
-
* @property {object} [contextMenuSettings] - _Updatable._
|
|
18441
|
-
* Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
|
|
18442
|
-
* Configure the context menu when right-clicking on a window.
|
|
18443
|
-
* @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
|
|
18444
|
-
* @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
|
|
18445
|
-
* @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
|
|
18446
|
-
*
|
|
18447
|
-
* @property {object} [contextMenuOptions] - _Updatable._
|
|
18448
|
-
* Configure the context menu when right-clicking on a window. Supported menu items:
|
|
18449
|
-
* 'separator'
|
|
18450
|
-
* 'cut'
|
|
18451
|
-
* 'copy'
|
|
18452
|
-
* 'paste'
|
|
18453
|
-
* 'spellCheck'
|
|
18454
|
-
* 'inspect'
|
|
18455
|
-
* 'reload'
|
|
18456
|
-
* 'navigateForward'
|
|
18457
|
-
* 'navigateBack'
|
|
18458
|
-
* 'print'
|
|
18459
|
-
* @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
|
|
18460
|
-
* @property {string[]} [contextMenuSettings.template=[]] List of context menu items to display on right-click.
|
|
18461
|
-
*
|
|
18462
|
-
* @property {object} [cornerRounding] - _Updatable._
|
|
18463
|
-
* Defines and applies rounded corners for a frameless window. **NOTE:** On macOS corner is not ellipse but circle rounded by the
|
|
18464
|
-
* average of _height_ and _width_.
|
|
18465
|
-
* @property {number} [cornerRounding.height=0] The height in pixels.
|
|
18466
|
-
* @property {number} [cornerRounding.width=0] The width in pixels.
|
|
18467
|
-
*
|
|
18468
|
-
* @property {any} [customContext=""] - _Updatable. Inheritable._
|
|
18469
|
-
* A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
|
|
18470
|
-
* is called. If a window in a Platform is trying to update or retrieve its own context, it can use the
|
|
18471
|
-
* {@link Platform#setWindowContext Platform.setWindowContext} and {@link Platform#getWindowContext Platform.getWindowContext} calls.
|
|
18472
|
-
* _When omitted, _inherits_ from the parent application._
|
|
18473
|
-
* As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
|
|
18474
|
-
*
|
|
18475
|
-
* @property {any} [customData=""] - _Updatable. Inheritable._
|
|
18476
|
-
* A field that the user can attach serializable data to be ferried around with the window options.
|
|
18477
|
-
* _When omitted, _inherits_ from the parent application._
|
|
18478
|
-
*
|
|
18479
|
-
* @property {object[]} [customRequestHeaders]
|
|
18480
|
-
* Defines list of custom headers for requests sent by the window.
|
|
18481
|
-
* @property {string[]} [customRequestHeaders.urlPatterns=[]] The URL patterns for which the headers will be applied
|
|
18482
|
-
* @property {object[]} [customRequestHeaders.headers=[]] Objects representing headers and their values,
|
|
18483
|
-
* where the object key is the name of header and value at key is the value of the header
|
|
18484
|
-
*
|
|
18485
|
-
* @property {boolean} [closeOnLastViewRemoved=true] - _Experimental._ _Updatable._
|
|
18486
|
-
* Toggling off would keep the Window alive even if all its Views were closed.
|
|
18487
|
-
* This is meant for advanced users and should be used with caution.
|
|
18488
|
-
* Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
|
|
18489
|
-
* Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
|
|
18490
|
-
* ** note ** - This option is ignored in non-Platforms apps.
|
|
18491
|
-
*
|
|
18492
|
-
* @property {boolean} [defaultCentered=false]
|
|
18493
|
-
* Centers the window in the primary monitor. This option overrides `defaultLeft` and `defaultTop`. When `saveWindowState` is `true`,
|
|
18494
|
-
* this value will be ignored for subsequent launches in favor of the cached value. **NOTE:** On macOS _defaultCenter_ is
|
|
18495
|
-
* somewhat above center vertically.
|
|
18496
|
-
*
|
|
18497
|
-
* @property {number} [defaultHeight=500]
|
|
18498
|
-
* The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
|
|
18499
|
-
* in favor of the cached value.
|
|
18500
|
-
*
|
|
18501
|
-
* @property {number} [defaultLeft=100]
|
|
18502
|
-
* The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
|
18503
|
-
* launches in favor of the cached value.
|
|
18504
|
-
*
|
|
18505
|
-
* @property {number} [defaultTop=100]
|
|
18506
|
-
* The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
|
18507
|
-
* launches in favor of the cached value.
|
|
18508
|
-
*
|
|
18509
|
-
* @property {number} [defaultWidth=800]
|
|
18510
|
-
* The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
|
18511
|
-
* launches in favor of the cached value.
|
|
18512
|
-
*
|
|
18513
|
-
* @property {boolean} [includeInSnapshots=true] - _Updatable._
|
|
18514
|
-
* When true, the window will be be included in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
|
|
18515
|
-
* inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
|
|
18516
|
-
*
|
|
18517
|
-
* @property {boolean} [frame=true] - _Updatable._
|
|
18518
|
-
* A flag to show the frame.
|
|
18519
|
-
*
|
|
18520
|
-
* @hidden-property {boolean} [hideOnClose=false] - A flag to allow a window to be hidden when the close button is clicked.
|
|
18521
|
-
*
|
|
18522
|
-
* @property {object[]} [hotkeys=[]] - _Updatable._
|
|
18523
|
-
* Defines the list of hotkeys that will be emitted as a `hotkey` event on the window. For usage example see [example]{@tutorial hotkeys}.
|
|
18524
|
-
* Within Platform, OpenFin also implements a set of pre-defined actions called
|
|
18525
|
-
* [keyboard commands]{@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands}
|
|
18526
|
-
* that can be assigned to a specific hotkey in the platform manifest.
|
|
18527
|
-
* @property {string} hotkeys.keys The key combination of the hotkey, i.e. "Ctrl+T"
|
|
18528
|
-
* @property {boolean} [hotkeys.preventDefault=false] Whether or not to prevent default key handling before emitting the event
|
|
18529
|
-
*
|
|
18530
|
-
* @property {string} [icon] - _Updatable. Inheritable._
|
|
18531
|
-
* A URL for the icon to be shown in the window title bar and the taskbar.
|
|
18532
|
-
* When omitted, inherits from the parent application._
|
|
18533
|
-
* note: Window OS caches taskbar icons, therefore an icon change might only be visible after the cache is removed or the uuid is changed.
|
|
18534
|
-
*
|
|
18535
|
-
* @property {number} [maxHeight=-1] - _Updatable._
|
|
18536
|
-
* The maximum height of a window. Will default to the OS defined value if set to -1.
|
|
18537
|
-
*
|
|
18538
|
-
* @property {boolean} [maximizable=true] - _Updatable._
|
|
18539
|
-
* A flag that lets the window be maximized.
|
|
18540
|
-
*
|
|
18541
|
-
* @property {number} [maxWidth=-1] - _Updatable._
|
|
18542
|
-
* The maximum width of a window. Will default to the OS defined value if set to -1.
|
|
18543
|
-
*
|
|
18544
|
-
* @property {number} [minHeight=0] - _Updatable._
|
|
18545
|
-
* The minimum height of a window.
|
|
18546
|
-
*
|
|
18547
|
-
* @property {boolean} [minimizable=true] - _Updatable._
|
|
18548
|
-
* A flag that lets the window be minimized.
|
|
18549
|
-
*
|
|
18550
|
-
* @property {number} [minWidth=0] - _Updatable._
|
|
18551
|
-
* The minimum width of a window.
|
|
18552
|
-
*
|
|
18553
|
-
* @property {Identity} [modalParentIdentity]
|
|
18554
|
-
* Parent identity of a modal window. It will create a modal child window when this option is set.
|
|
18555
|
-
*
|
|
18556
|
-
* @property {string} name
|
|
18557
|
-
* The name of the window.
|
|
18558
|
-
*
|
|
18559
|
-
* @property {number} [opacity=1.0] - _Updatable._
|
|
18560
|
-
* A flag that specifies how transparent the window will be.
|
|
18561
|
-
* Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
|
|
18562
|
-
* This value is clamped between `0.0` and `1.0`.
|
|
18563
|
-
* * In software composition mode, the runtime flag --allow-unsafe-compositing is required.
|
|
18564
|
-
*
|
|
18565
|
-
* @property {preloadScript[]} [preloadScripts] - _Inheritable_
|
|
18566
|
-
* A list of scripts that are eval'ed before other scripts in the page. When omitted, _inherits_
|
|
18567
|
-
* from the parent application.
|
|
18568
|
-
*
|
|
18569
|
-
* @property {string} [processAffinity]
|
|
18570
|
-
* A string to attempt to group renderers together. Will only be used if pages are on the same origin.
|
|
18571
|
-
*
|
|
18572
|
-
* @property {boolean} [resizable=true] - _Updatable._
|
|
18573
|
-
* A flag to allow the user to resize the window.
|
|
18574
|
-
*
|
|
18575
|
-
* @property {object} [resizeRegion] - _Updatable._
|
|
18576
|
-
* Defines a region in pixels that will respond to user mouse interaction for resizing a frameless window.
|
|
18577
|
-
* @property {number} [resizeRegion.bottomRightCorner=9]
|
|
18578
|
-
* The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
|
|
18579
|
-
* @property {number} [resizeRegion.size=7]
|
|
18580
|
-
* The size in pixels.
|
|
18581
|
-
* @property {object} [resizeRegion.sides={top:true,right:true,bottom:true,left:true}]
|
|
18582
|
-
* Sides that a window can be resized from.
|
|
18583
|
-
*
|
|
18584
|
-
* @property {boolean} [saveWindowState=true]
|
|
18585
|
-
* A flag to cache the location of the window.
|
|
18586
|
-
* ** note ** - This option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
|
|
18587
|
-
*
|
|
18588
|
-
* @property {boolean} [ignoreSavedWindowState]
|
|
18589
|
-
* A flag to ignore previously cached state of the window. It defaults the opposite value of `saveWindowState` to maintain backwards compatibility.
|
|
18590
|
-
*
|
|
18591
|
-
* @property {boolean} [shadow=false]
|
|
18592
|
-
* A flag to display a shadow on frameless windows.
|
|
18593
|
-
* `shadow` and `cornerRounding` are mutually exclusive.
|
|
18594
|
-
* On Windows 7, Aero theme is required.
|
|
18595
|
-
*
|
|
18596
|
-
* @property {boolean} [showBackgroundImages=false] - _Updatable._
|
|
18597
|
-
* Platforms Only. If true, will show background images in the layout when the Views are hidden.
|
|
18598
|
-
* This occurs when the window is resizing or a tab is being dragged within the layout.
|
|
18599
|
-
*
|
|
18600
|
-
* @property {boolean} [showTaskbarIcon=true] - _Updatable._ _Windows_.
|
|
18601
|
-
* A flag to show the window's icon in the taskbar.
|
|
18602
|
-
*
|
|
18603
|
-
* @property {boolean} [smallWindow=false]
|
|
18604
|
-
* A flag to specify a frameless window that can be be created and resized to less than 41x36 px (width x height).
|
|
18605
|
-
* _Note: Caveats of small windows are no Aero Snap and drag to/from maximize._
|
|
18606
|
-
* _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
|
|
18607
|
-
*
|
|
18608
|
-
* @property {boolean} [spellCheck=false]
|
|
18609
|
-
* Enable spell check in input text fields for the window.
|
|
18610
|
-
*
|
|
18611
|
-
* @property {string} [state="normal"]
|
|
18612
|
-
* The visible state of the window on creation.
|
|
18613
|
-
* One of:
|
|
18614
|
-
* * `"maximized"`
|
|
18615
|
-
* * `"minimized"`
|
|
18616
|
-
* * `"normal"`
|
|
18617
|
-
*
|
|
18618
|
-
* @property {string} [taskbarIcon=string] - Deprecated - use `icon` instead._Windows_.
|
|
18619
|
-
*
|
|
18620
|
-
* @property {string} [taskbarIconGroup=<application uuid>] - _Windows_.
|
|
18621
|
-
* Specify a taskbar group for the window.
|
|
18622
|
-
* _If omitted, defaults to app's uuid (`fin.Application.getCurrentSync().identity.uuid`)._
|
|
18623
|
-
*
|
|
18624
|
-
* @property {string} [url="about:blank"]
|
|
18625
|
-
* The URL of the window.
|
|
18626
|
-
*
|
|
18627
|
-
* @property {string} [uuid=<application uuid>]
|
|
18628
|
-
* The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
|
|
18629
|
-
* If omitted, defaults to the `uuid` of the application spawning the window.
|
|
18630
|
-
* If given, must match the `uuid` of the application spawning the window.
|
|
18631
|
-
* In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
|
|
18632
|
-
* really no need to provide it.
|
|
18633
|
-
*
|
|
18634
|
-
* @property {boolean} [waitForPageLoad=false]
|
|
18635
|
-
* When set to `true`, the window will not appear until the `window` object's `load` event fires.
|
|
18636
|
-
* When set to `false`, the window will appear immediately without waiting for content to be loaded.
|
|
18637
|
-
*
|
|
18638
|
-
* @property {ViewVisibility} [viewVisibility]
|
|
18639
|
-
* _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
|
|
18640
|
-
*/
|
|
18641
|
-
/**
|
|
18642
|
-
* @PORTED
|
|
18643
|
-
* @typedef {Object} ViewVisibility@typedef {Object} ViewVisibility _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
|
|
18644
|
-
* @property {ShowViewsOnWindowResize} [showViewsOnWindowResize] Enables views to be shown when a Platform Window is being resized by the user.
|
|
18645
|
-
* @property {ShowViewsOnSplitterDrag} [showViewsOnSplitterDrag] Allows views to be shown when they are resized by the user dragging the splitter between layout stacks.
|
|
18646
|
-
* @property {ShowViewsOnTabDrag} [showViewsOnTabDrag] _Supported on Windows Operating Systems only_. Allows views to be shown when the user is dragging a tab around a layout.
|
|
18647
|
-
*/
|
|
18648
|
-
/**
|
|
18649
|
-
* @PORTED
|
|
18650
|
-
* @typedef {Object} ShowViewsOnWindowResize@typedef {Object} ShowViewsOnWindowResize _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
|
|
18651
|
-
* @property {boolean} [enabled=false] Enables or disables showing Views when a Platform Window is being resized.
|
|
18652
|
-
* @property {number} [paintIntervalMs=0] Number of miliseconds to wait between view repaints.
|
|
18653
|
-
*/
|
|
18654
|
-
/**
|
|
18655
|
-
* @REMOVED
|
|
18656
|
-
* @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.
|
|
18657
|
-
* @property {boolean} [enabled=false] Enables or disables showing views when the layout splitter is being dragged.
|
|
18658
|
-
*/
|
|
18659
|
-
/**
|
|
18660
|
-
* @REMOVED
|
|
18661
|
-
* @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.
|
|
18662
|
-
* @property {boolean} [enabled=false] Enables or disables showing views when a tab is being dragged.
|
|
18663
|
-
*/
|
|
18664
|
-
/**
|
|
18665
|
-
* @PORTED
|
|
18666
|
-
* @typedef {object} CapturePageOptions@typedef {object} CapturePageOptions
|
|
18667
|
-
* @property { Area } [area] The area of the window to be captured.
|
|
18668
|
-
* @property { string } [format='png'] The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
|
|
18669
|
-
* @property { number } [quality=100] Number representing quality of JPEG image only. Between 0 - 100.
|
|
18670
|
-
*/
|
|
18671
|
-
/**
|
|
18672
|
-
* @PORTED
|
|
18673
|
-
* @typedef { object } Area@typedef { object } Area
|
|
18674
|
-
* @property { number } height Area's height
|
|
18675
|
-
* @property { number } width Area's width
|
|
18676
|
-
* @property { number } x X coordinate of area's starting point
|
|
18677
|
-
* @property { number } y Y coordinate of area's starting point
|
|
18678
|
-
*/
|
|
18679
|
-
/**
|
|
18680
|
-
* @PORTED
|
|
18681
|
-
* @typedef {object} FindInPageOptions@typedef {object} FindInPageOptions
|
|
18682
|
-
* @property {boolean} [forward=true] Whether to search forward or backward.
|
|
18683
|
-
* @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.
|
|
18684
|
-
* @property {boolean} [matchCase=false] Whether search should be case-sensitive.
|
|
18685
|
-
* @property {boolean} [wordStart=false] Whether to look only at the start of words.
|
|
18686
|
-
* @property {boolean} [medialCapitalAsWordStart=false]
|
|
18687
|
-
* 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>
|
|
18688
|
-
* lowercase or non-letter. Accepts several other intra-word matches.
|
|
18689
|
-
*/
|
|
18690
|
-
/**
|
|
18691
|
-
* @REMOVED
|
|
18692
|
-
* @typedef {object} Transition@typedef {object} Transition
|
|
18693
|
-
* @property {Opacity} opacity - The Opacity transition
|
|
18694
|
-
* @property {Position} position - The Position transition
|
|
18695
|
-
* @property {Size} size - The Size transition
|
|
18696
|
-
*/
|
|
18697
|
-
/**
|
|
18698
|
-
* @PORTED
|
|
18699
|
-
* @typedef {object} TransitionOptions@typedef {object} TransitionOptions
|
|
18700
|
-
* @property {boolean} interrupt - This option interrupts the current animation. When false it pushes
|
|
18701
|
-
this animation onto the end of the animation queue.
|
|
18702
|
-
* @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
|
|
18703
|
-
*/
|
|
18704
|
-
/**
|
|
18705
|
-
* @PORTED
|
|
18706
|
-
* @typedef {object} Size@typedef {object} Size
|
|
18707
|
-
* @property {number} duration - The total time in milliseconds this transition should take.
|
|
18708
|
-
* @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
|
|
18709
|
-
* @property {number} width - Optional if height is present. Defaults to the window's current width.
|
|
18710
|
-
* @property {number} height - Optional if width is present. Defaults to the window's current height.
|
|
18711
|
-
*/
|
|
18712
|
-
/**
|
|
18713
|
-
* @PORTED
|
|
18714
|
-
* @typedef {object} Position@typedef {object} Position
|
|
18715
|
-
* @property {number} duration - The total time in milliseconds this transition should take.
|
|
18716
|
-
* @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
|
|
18717
|
-
* @property {number} left - Defaults to the window's current left position in virtual screen coordinates.
|
|
18718
|
-
* @property {number} top - Defaults to the window's current top position in virtual screen coordinates.
|
|
18719
|
-
*/
|
|
18720
|
-
/**
|
|
18721
|
-
* @PORTED
|
|
18722
|
-
* @typedef {object} Opacity@typedef {object} Opacity
|
|
18723
|
-
* @property {number} duration - The total time in milliseconds this transition should take.
|
|
18724
|
-
* @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
|
|
18725
|
-
* @property {number} opacity - This value is clamped from 0.0 to 1.0.
|
|
18726
|
-
*/
|
|
18727
|
-
/**
|
|
18728
|
-
* @REMOVED
|
|
18729
|
-
* Bounds is a interface that has the properties of height,
|
|
18730
|
-
* width, left, top which are all numbers
|
|
18731
|
-
* @typedef { object } Bounds@typedef { object } Bounds
|
|
18732
|
-
* @property { number } height Get the application height bound
|
|
18733
|
-
* @property { number } width Get the application width bound
|
|
18734
|
-
* @property { number } top Get the application top bound
|
|
18735
|
-
* @property { number } left Get the application left bound
|
|
18736
|
-
* @property { number } right Get the application right bound
|
|
18737
|
-
* @property { number } bottom Get the application bottom bound
|
|
18738
|
-
*/
|
|
18739
17535
|
/**
|
|
18740
17536
|
* A basic window that wraps a native HTML window. Provides more fine-grained
|
|
18741
17537
|
* control over the window state such as the ability to minimize, maximize, restore, etc.
|
|
@@ -18748,83 +17544,6 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
18748
17544
|
* @internal
|
|
18749
17545
|
*/
|
|
18750
17546
|
constructor(wire: Transport, identity: OpenFin_2.Identity);
|
|
18751
|
-
/**
|
|
18752
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
|
18753
|
-
* @param eventType - The type of the event.
|
|
18754
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
|
18755
|
-
* @param options - Option to support event timestamps.
|
|
18756
|
-
*
|
|
18757
|
-
* @function addListener
|
|
18758
|
-
* @memberof Window
|
|
18759
|
-
* @instance
|
|
18760
|
-
* @tutorial Window.EventEmitter
|
|
18761
|
-
*/
|
|
18762
|
-
/**
|
|
18763
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
|
18764
|
-
* @param eventType - The type of the event.
|
|
18765
|
-
* @param listener - Called whenever an event of the specified type occurs.
|
|
18766
|
-
* @param options - Option to support event timestamps.
|
|
18767
|
-
*
|
|
18768
|
-
* @function on
|
|
18769
|
-
* @memberof Window
|
|
18770
|
-
* @instance
|
|
18771
|
-
* @tutorial Window.EventEmitter
|
|
18772
|
-
*/
|
|
18773
|
-
/**
|
|
18774
|
-
* 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.
|
|
18775
|
-
* @param eventType - The type of the event.
|
|
18776
|
-
* @param listener - The callback function.
|
|
18777
|
-
* @param options - Option to support event timestamps.
|
|
18778
|
-
*
|
|
18779
|
-
* @function once
|
|
18780
|
-
* @memberof Window
|
|
18781
|
-
* @instance
|
|
18782
|
-
* @tutorial Window.EventEmitter
|
|
18783
|
-
*/
|
|
18784
|
-
/**
|
|
18785
|
-
* Adds a listener to the beginning of the listeners array for the specified event.
|
|
18786
|
-
* @param eventType - The type of the event.
|
|
18787
|
-
* @param listener - The callback function.
|
|
18788
|
-
* @param options - Option to support event timestamps.
|
|
18789
|
-
*
|
|
18790
|
-
* @function prependListener
|
|
18791
|
-
* @memberof Window
|
|
18792
|
-
* @instance
|
|
18793
|
-
* @tutorial Window.EventEmitter
|
|
18794
|
-
*/
|
|
18795
|
-
/**
|
|
18796
|
-
* 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.
|
|
18797
|
-
* The listener is added to the beginning of the listeners array.
|
|
18798
|
-
* @param eventType - The type of the event.
|
|
18799
|
-
* @param listener - The callback function.
|
|
18800
|
-
* @param options - Option to support event timestamps.
|
|
18801
|
-
*
|
|
18802
|
-
* @function prependOnceListener
|
|
18803
|
-
* @memberof Window
|
|
18804
|
-
* @instance
|
|
18805
|
-
* @tutorial Window.EventEmitter
|
|
18806
|
-
*/
|
|
18807
|
-
/**
|
|
18808
|
-
* Remove a listener from the listener array for the specified event.
|
|
18809
|
-
* Caution: Calling this method changes the array indices in the listener array behind the listener.
|
|
18810
|
-
* @param eventType - The type of the event.
|
|
18811
|
-
* @param listener - The callback function.
|
|
18812
|
-
* @param options - Option to support event timestamps.
|
|
18813
|
-
*
|
|
18814
|
-
* @function removeListener
|
|
18815
|
-
* @memberof Window
|
|
18816
|
-
* @instance
|
|
18817
|
-
* @tutorial Window.EventEmitter
|
|
18818
|
-
*/
|
|
18819
|
-
/**
|
|
18820
|
-
* Removes all listeners, or those of the specified event.
|
|
18821
|
-
* @param eventType - The type of the event.
|
|
18822
|
-
*
|
|
18823
|
-
* @function removeAllListeners
|
|
18824
|
-
* @memberof Window
|
|
18825
|
-
* @instance
|
|
18826
|
-
* @tutorial Window.EventEmitter
|
|
18827
|
-
*/
|
|
18828
17547
|
/**
|
|
18829
17548
|
* create a new window
|
|
18830
17549
|
* @internal
|
|
@@ -19605,10 +18324,9 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
19605
18324
|
show(force?: boolean): Promise<void>;
|
|
19606
18325
|
/**
|
|
19607
18326
|
* Shows the window if it is hidden at the specified location.
|
|
19608
|
-
*
|
|
19609
|
-
*
|
|
19610
|
-
* @param
|
|
19611
|
-
* @param top The right position of the window
|
|
18327
|
+
*
|
|
18328
|
+
* @param left The left position of the window in pixels
|
|
18329
|
+
* @param top The top position of the window in pixels
|
|
19612
18330
|
* @param force Show will be prevented from closing when force is false and
|
|
19613
18331
|
* ‘show-requested’ has been subscribed to for application’s main window
|
|
19614
18332
|
*
|
|
@@ -19670,28 +18388,6 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
19670
18388
|
* ```
|
|
19671
18389
|
*/
|
|
19672
18390
|
authenticate(userName: string, password: string): Promise<void>;
|
|
19673
|
-
/**
|
|
19674
|
-
* @typedef {object} ShowPopupMenuOptions@typedef {object} ShowPopupMenuOptions
|
|
19675
|
-
* @property {Array<MenuItemTemplate>} template - An array describing the menu to show.
|
|
19676
|
-
* @property {number} [x] - The window x coordinate where to show the menu. Defaults to mouse position. If using must also use `y`.
|
|
19677
|
-
* @property {number} [y] - The window y coordinate where to show the menu. Defaults to mouse position. If using must also use `x`
|
|
19678
|
-
*/
|
|
19679
|
-
/**
|
|
19680
|
-
* @typedef {object} MenuItemTemplate@typedef {object} MenuItemTemplate
|
|
19681
|
-
* @property {*} data - Data to be returned if the user selects the element. Must be serializable. Large objects can have a performance impact.
|
|
19682
|
-
* @property {'normal' | 'separator' | 'submenu' | 'checkbox'} [type] - Defaults to 'normal' unless a 'submenu' key exists
|
|
19683
|
-
* @property {string} [label] - The text to show on the menu item. Should be left undefined for `type: 'separator'`
|
|
19684
|
-
* @property {boolean} [enabled] - If false, the menu item will be greyed out and unclickable.
|
|
19685
|
-
* @property {boolean} [visible] - If false, the menu item will be entirely hidden.
|
|
19686
|
-
* @property {boolean} [checked] - Should only be specified for `checkbox` type menu items.
|
|
19687
|
-
* @property {string} [icon] - Image Data URI with image dimensions inferred from the encoded string
|
|
19688
|
-
* @property {Array<MenuItemTemplate>} [submenu] Should be specified for `submenu` type menu items. If `submenu` is specified, the `type: 'submenu'` can be omitted.
|
|
19689
|
-
*/
|
|
19690
|
-
/**
|
|
19691
|
-
* @typedef {object} MenuResult@typedef {object} MenuResult
|
|
19692
|
-
* @property {'clicked' | 'closed'} result - Whether the user clicked on a menu item or the menu was closed (user clicked elsewhere).
|
|
19693
|
-
* @property {* | undefined} [data] - The data property of the menu item clicked by the user. Only defined if result was `clicked`.
|
|
19694
|
-
*/
|
|
19695
18391
|
/**
|
|
19696
18392
|
* Shows a menu on the window.
|
|
19697
18393
|
*
|
|
@@ -19788,590 +18484,565 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
|
19788
18484
|
*/
|
|
19789
18485
|
closePopupMenu(): Promise<void>;
|
|
19790
18486
|
/**
|
|
19791
|
-
*
|
|
19792
|
-
*
|
|
19793
|
-
* @
|
|
19794
|
-
* @
|
|
19795
|
-
*
|
|
19796
|
-
|
|
19797
|
-
|
|
19798
|
-
|
|
19799
|
-
|
|
19800
|
-
|
|
19801
|
-
|
|
19802
|
-
|
|
19803
|
-
|
|
19804
|
-
|
|
19805
|
-
|
|
19806
|
-
|
|
19807
|
-
|
|
19808
|
-
|
|
19809
|
-
|
|
19810
|
-
|
|
19811
|
-
|
|
19812
|
-
|
|
19813
|
-
|
|
19814
|
-
|
|
19815
|
-
|
|
19816
|
-
|
|
19817
|
-
|
|
19818
|
-
|
|
19819
|
-
|
|
19820
|
-
|
|
19821
|
-
|
|
19822
|
-
|
|
19823
|
-
|
|
19824
|
-
|
|
19825
|
-
|
|
19826
|
-
|
|
19827
|
-
|
|
19828
|
-
|
|
19829
|
-
|
|
19830
|
-
|
|
19831
|
-
|
|
19832
|
-
|
|
19833
|
-
|
|
19834
|
-
|
|
19835
|
-
|
|
19836
|
-
|
|
19837
|
-
|
|
19838
|
-
|
|
19839
|
-
|
|
19840
|
-
|
|
19841
|
-
|
|
19842
|
-
|
|
19843
|
-
|
|
19844
|
-
|
|
19845
|
-
|
|
19846
|
-
|
|
19847
|
-
|
|
19848
|
-
|
|
19849
|
-
|
|
19850
|
-
|
|
19851
|
-
|
|
19852
|
-
|
|
19853
|
-
|
|
19854
|
-
|
|
19855
|
-
|
|
19856
|
-
|
|
19857
|
-
|
|
19858
|
-
|
|
19859
|
-
|
|
19860
|
-
|
|
19861
|
-
|
|
19862
|
-
|
|
19863
|
-
|
|
19864
|
-
|
|
19865
|
-
|
|
19866
|
-
|
|
19867
|
-
|
|
19868
|
-
|
|
19869
|
-
|
|
19870
|
-
|
|
19871
|
-
|
|
19872
|
-
|
|
19873
|
-
|
|
19874
|
-
|
|
19875
|
-
|
|
19876
|
-
|
|
19877
|
-
|
|
19878
|
-
|
|
19879
|
-
|
|
19880
|
-
|
|
19881
|
-
|
|
19882
|
-
|
|
19883
|
-
|
|
19884
|
-
|
|
19885
|
-
|
|
19886
|
-
|
|
19887
|
-
|
|
19888
|
-
|
|
19889
|
-
|
|
19890
|
-
|
|
19891
|
-
|
|
19892
|
-
|
|
19893
|
-
|
|
19894
|
-
|
|
19895
|
-
|
|
19896
|
-
|
|
19897
|
-
|
|
19898
|
-
|
|
19899
|
-
|
|
19900
|
-
|
|
19901
|
-
|
|
19902
|
-
|
|
19903
|
-
|
|
19904
|
-
|
|
19905
|
-
|
|
19906
|
-
|
|
19907
|
-
|
|
19908
|
-
|
|
19909
|
-
|
|
19910
|
-
|
|
19911
|
-
|
|
19912
|
-
|
|
19913
|
-
|
|
19914
|
-
|
|
19915
|
-
|
|
19916
|
-
|
|
19917
|
-
|
|
19918
|
-
|
|
19919
|
-
|
|
19920
|
-
|
|
19921
|
-
|
|
19922
|
-
|
|
19923
|
-
|
|
19924
|
-
|
|
19925
|
-
|
|
19926
|
-
|
|
19927
|
-
|
|
19928
|
-
|
|
19929
|
-
|
|
19930
|
-
|
|
19931
|
-
|
|
19932
|
-
|
|
19933
|
-
|
|
19934
|
-
|
|
19935
|
-
|
|
19936
|
-
|
|
19937
|
-
|
|
19938
|
-
|
|
19939
|
-
|
|
19940
|
-
|
|
19941
|
-
|
|
19942
|
-
|
|
19943
|
-
|
|
19944
|
-
|
|
19945
|
-
|
|
19946
|
-
|
|
19947
|
-
|
|
19948
|
-
|
|
19949
|
-
|
|
19950
|
-
|
|
19951
|
-
|
|
19952
|
-
|
|
19953
|
-
|
|
19954
|
-
|
|
19955
|
-
|
|
19956
|
-
|
|
19957
|
-
|
|
19958
|
-
|
|
19959
|
-
|
|
19960
|
-
|
|
19961
|
-
|
|
19962
|
-
|
|
19963
|
-
|
|
19964
|
-
|
|
19965
|
-
|
|
19966
|
-
|
|
19967
|
-
|
|
19968
|
-
|
|
19969
|
-
|
|
19970
|
-
|
|
19971
|
-
|
|
19972
|
-
|
|
19973
|
-
|
|
19974
|
-
|
|
19975
|
-
|
|
19976
|
-
|
|
19977
|
-
|
|
19978
|
-
|
|
19979
|
-
|
|
19980
|
-
|
|
19981
|
-
|
|
19982
|
-
|
|
19983
|
-
|
|
19984
|
-
|
|
19985
|
-
|
|
19986
|
-
|
|
19987
|
-
|
|
19988
|
-
|
|
19989
|
-
|
|
19990
|
-
|
|
19991
|
-
|
|
19992
|
-
|
|
19993
|
-
|
|
19994
|
-
|
|
19995
|
-
|
|
19996
|
-
|
|
19997
|
-
|
|
19998
|
-
|
|
19999
|
-
|
|
20000
|
-
|
|
20001
|
-
|
|
20002
|
-
|
|
20003
|
-
|
|
20004
|
-
|
|
20005
|
-
|
|
20006
|
-
|
|
20007
|
-
|
|
20008
|
-
|
|
20009
|
-
|
|
20010
|
-
|
|
20011
|
-
|
|
20012
|
-
|
|
20013
|
-
|
|
20014
|
-
|
|
20015
|
-
|
|
20016
|
-
|
|
20017
|
-
|
|
20018
|
-
|
|
20019
|
-
|
|
20020
|
-
|
|
20021
|
-
|
|
20022
|
-
|
|
20023
|
-
|
|
20024
|
-
|
|
20025
|
-
|
|
20026
|
-
|
|
20027
|
-
|
|
20028
|
-
|
|
20029
|
-
|
|
20030
|
-
|
|
20031
|
-
|
|
20032
|
-
|
|
20033
|
-
|
|
20034
|
-
|
|
20035
|
-
|
|
20036
|
-
|
|
20037
|
-
|
|
20038
|
-
|
|
20039
|
-
|
|
20040
|
-
|
|
20041
|
-
|
|
20042
|
-
|
|
20043
|
-
|
|
20044
|
-
|
|
20045
|
-
|
|
20046
|
-
|
|
20047
|
-
|
|
20048
|
-
|
|
20049
|
-
|
|
20050
|
-
|
|
20051
|
-
|
|
20052
|
-
|
|
20053
|
-
|
|
20054
|
-
|
|
20055
|
-
|
|
20056
|
-
|
|
20057
|
-
|
|
20058
|
-
|
|
20059
|
-
|
|
20060
|
-
|
|
20061
|
-
|
|
20062
|
-
|
|
20063
|
-
|
|
20064
|
-
|
|
20065
|
-
|
|
20066
|
-
|
|
20067
|
-
|
|
20068
|
-
|
|
20069
|
-
|
|
20070
|
-
|
|
20071
|
-
|
|
20072
|
-
|
|
20073
|
-
|
|
20074
|
-
|
|
20075
|
-
|
|
20076
|
-
|
|
20077
|
-
|
|
20078
|
-
|
|
20079
|
-
|
|
20080
|
-
|
|
20081
|
-
|
|
20082
|
-
|
|
20083
|
-
|
|
20084
|
-
|
|
20085
|
-
|
|
20086
|
-
|
|
20087
|
-
|
|
20088
|
-
|
|
20089
|
-
|
|
20090
|
-
|
|
20091
|
-
|
|
20092
|
-
|
|
20093
|
-
|
|
20094
|
-
}
|
|
20095
|
-
|
|
20096
|
-
|
|
20097
|
-
|
|
20098
|
-
|
|
20099
|
-
|
|
20100
|
-
|
|
20101
|
-
|
|
20102
|
-
|
|
20103
|
-
|
|
20104
|
-
|
|
20105
|
-
|
|
20106
|
-
|
|
20107
|
-
|
|
20108
|
-
|
|
20109
|
-
|
|
20110
|
-
|
|
20111
|
-
|
|
20112
|
-
|
|
20113
|
-
|
|
20114
|
-
|
|
20115
|
-
|
|
20116
|
-
|
|
20117
|
-
|
|
20118
|
-
|
|
20119
|
-
|
|
20120
|
-
|
|
20121
|
-
|
|
20122
|
-
|
|
20123
|
-
|
|
20124
|
-
|
|
20125
|
-
|
|
20126
|
-
|
|
20127
|
-
|
|
20128
|
-
|
|
20129
|
-
|
|
20130
|
-
|
|
20131
|
-
|
|
20132
|
-
|
|
20133
|
-
|
|
20134
|
-
|
|
20135
|
-
|
|
20136
|
-
|
|
20137
|
-
|
|
20138
|
-
|
|
20139
|
-
|
|
20140
|
-
|
|
20141
|
-
|
|
20142
|
-
|
|
20143
|
-
|
|
20144
|
-
|
|
20145
|
-
|
|
20146
|
-
|
|
20147
|
-
|
|
20148
|
-
|
|
20149
|
-
|
|
20150
|
-
|
|
20151
|
-
|
|
20152
|
-
|
|
20153
|
-
|
|
20154
|
-
|
|
20155
|
-
|
|
20156
|
-
|
|
20157
|
-
|
|
20158
|
-
|
|
20159
|
-
|
|
20160
|
-
|
|
20161
|
-
|
|
20162
|
-
|
|
20163
|
-
|
|
20164
|
-
|
|
20165
|
-
|
|
20166
|
-
|
|
20167
|
-
|
|
20168
|
-
|
|
20169
|
-
|
|
20170
|
-
|
|
20171
|
-
|
|
20172
|
-
|
|
20173
|
-
|
|
20174
|
-
|
|
20175
|
-
|
|
20176
|
-
|
|
20177
|
-
|
|
20178
|
-
|
|
20179
|
-
|
|
20180
|
-
|
|
20181
|
-
|
|
20182
|
-
|
|
20183
|
-
|
|
20184
|
-
|
|
20185
|
-
|
|
20186
|
-
|
|
20187
|
-
|
|
20188
|
-
|
|
20189
|
-
|
|
20190
|
-
|
|
20191
|
-
|
|
20192
|
-
|
|
20193
|
-
|
|
20194
|
-
|
|
20195
|
-
|
|
20196
|
-
|
|
20197
|
-
|
|
20198
|
-
|
|
20199
|
-
|
|
20200
|
-
|
|
20201
|
-
|
|
20202
|
-
|
|
20203
|
-
|
|
20204
|
-
|
|
20205
|
-
|
|
20206
|
-
|
|
20207
|
-
|
|
20208
|
-
|
|
20209
|
-
|
|
20210
|
-
|
|
20211
|
-
|
|
20212
|
-
|
|
20213
|
-
|
|
20214
|
-
|
|
20215
|
-
|
|
20216
|
-
|
|
20217
|
-
|
|
20218
|
-
|
|
20219
|
-
|
|
20220
|
-
|
|
20221
|
-
|
|
20222
|
-
|
|
20223
|
-
|
|
20224
|
-
|
|
20225
|
-
|
|
20226
|
-
|
|
20227
|
-
|
|
20228
|
-
|
|
20229
|
-
|
|
20230
|
-
|
|
20231
|
-
|
|
20232
|
-
|
|
20233
|
-
|
|
20234
|
-
|
|
20235
|
-
|
|
20236
|
-
|
|
20237
|
-
|
|
20238
|
-
|
|
20239
|
-
|
|
20240
|
-
|
|
20241
|
-
|
|
20242
|
-
|
|
20243
|
-
|
|
20244
|
-
|
|
20245
|
-
|
|
20246
|
-
|
|
20247
|
-
|
|
20248
|
-
|
|
20249
|
-
|
|
20250
|
-
|
|
20251
|
-
|
|
20252
|
-
|
|
20253
|
-
|
|
20254
|
-
|
|
20255
|
-
|
|
20256
|
-
|
|
20257
|
-
|
|
20258
|
-
|
|
20259
|
-
|
|
20260
|
-
|
|
20261
|
-
|
|
20262
|
-
|
|
20263
|
-
|
|
20264
|
-
|
|
20265
|
-
|
|
20266
|
-
|
|
20267
|
-
|
|
20268
|
-
|
|
20269
|
-
|
|
20270
|
-
|
|
20271
|
-
|
|
20272
|
-
|
|
20273
|
-
|
|
20274
|
-
|
|
20275
|
-
|
|
20276
|
-
|
|
20277
|
-
|
|
20278
|
-
|
|
20279
|
-
|
|
20280
|
-
|
|
20281
|
-
|
|
20282
|
-
|
|
20283
|
-
|
|
20284
|
-
|
|
20285
|
-
|
|
20286
|
-
|
|
20287
|
-
|
|
20288
|
-
|
|
20289
|
-
|
|
20290
|
-
|
|
20291
|
-
|
|
20292
|
-
|
|
20293
|
-
|
|
20294
|
-
|
|
20295
|
-
|
|
20296
|
-
|
|
20297
|
-
|
|
20298
|
-
|
|
20299
|
-
|
|
20300
|
-
|
|
20301
|
-
|
|
20302
|
-
|
|
20303
|
-
|
|
20304
|
-
|
|
20305
|
-
|
|
20306
|
-
|
|
20307
|
-
|
|
20308
|
-
|
|
20309
|
-
|
|
20310
|
-
|
|
20311
|
-
|
|
20312
|
-
|
|
20313
|
-
|
|
20314
|
-
|
|
20315
|
-
|
|
20316
|
-
|
|
20317
|
-
|
|
20318
|
-
|
|
20319
|
-
|
|
20320
|
-
|
|
20321
|
-
|
|
20322
|
-
|
|
20323
|
-
|
|
20324
|
-
|
|
20325
|
-
|
|
20326
|
-
|
|
20327
|
-
|
|
20328
|
-
|
|
20329
|
-
|
|
20330
|
-
|
|
20331
|
-
|
|
20332
|
-
|
|
20333
|
-
|
|
20334
|
-
|
|
20335
|
-
|
|
20336
|
-
|
|
20337
|
-
|
|
20338
|
-
|
|
20339
|
-
|
|
20340
|
-
|
|
20341
|
-
|
|
20342
|
-
|
|
20343
|
-
|
|
20344
|
-
|
|
20345
|
-
|
|
20346
|
-
|
|
20347
|
-
|
|
20348
|
-
|
|
20349
|
-
|
|
20350
|
-
|
|
20351
|
-
|
|
20352
|
-
|
|
20353
|
-
data: string;
|
|
20354
|
-
};
|
|
20355
|
-
|
|
20356
|
-
/**
|
|
20357
|
-
* @interface
|
|
20358
|
-
*/
|
|
20359
|
-
declare type WriteImageClipboardRequest = BaseClipboardRequest & {
|
|
20360
|
-
/**
|
|
20361
|
-
* Can be either a base64 string, or a DataURL string. If using DataURL, the
|
|
20362
|
-
* supported formats are `data:image/png[;base64],` and `data:image/jpeg[;base64],`.
|
|
20363
|
-
* Using other image/<format> DataURLs will throw an Error.
|
|
20364
|
-
*/
|
|
20365
|
-
image: string;
|
|
20366
|
-
};
|
|
20367
|
-
|
|
20368
|
-
/**
|
|
20369
|
-
* @deprecated - instead use OpenFin.WriteClipboardRequest
|
|
20370
|
-
*
|
|
20371
|
-
* A request to write data to the clipboard.
|
|
20372
|
-
*
|
|
20373
|
-
* @interface
|
|
20374
|
-
*/
|
|
20375
|
-
declare type WriteRequestType = WriteClipboardRequest;
|
|
20376
|
-
|
|
20377
|
-
export { }
|
|
18487
|
+
* Dispatch a result to the caller of `showPopupWindow`.
|
|
18488
|
+
*
|
|
18489
|
+
* @remarks If this window isn't currently being shown as a popup, this call will silently fail.
|
|
18490
|
+
* @param data Serializable data to send to the caller window.
|
|
18491
|
+
*
|
|
18492
|
+
* @example
|
|
18493
|
+
* ```js
|
|
18494
|
+
* await fin.me.dispatchPopupResult({
|
|
18495
|
+
* foo: 'bar'
|
|
18496
|
+
* });
|
|
18497
|
+
* ```
|
|
18498
|
+
*/
|
|
18499
|
+
dispatchPopupResult(data: any): Promise<void>;
|
|
18500
|
+
/**
|
|
18501
|
+
* Prints the contents of the window.
|
|
18502
|
+
*
|
|
18503
|
+
* @param options Configuration for the print task.
|
|
18504
|
+
* @remarks When `silent` is set to `true`, the API will pick the system's default printer if deviceName is empty
|
|
18505
|
+
* and the default settings for printing.
|
|
18506
|
+
*
|
|
18507
|
+
* Use the CSS style `page-break-before: always;` to force print to a new page.
|
|
18508
|
+
*
|
|
18509
|
+
* @example
|
|
18510
|
+
* ```js
|
|
18511
|
+
* const win = fin.Window.getCurrentSync();
|
|
18512
|
+
*
|
|
18513
|
+
* win.print({ silent: false, deviceName: 'system-printer-name' }).then(() => {
|
|
18514
|
+
* console.log('print call has been sent to the system');
|
|
18515
|
+
* });
|
|
18516
|
+
* ```
|
|
18517
|
+
*
|
|
18518
|
+
* If a window has embedded views, those views will not print by default. To print a window's contents including embedded views,
|
|
18519
|
+
* use the `content` option:
|
|
18520
|
+
*
|
|
18521
|
+
* ```js
|
|
18522
|
+
* const win = fin.Window.getCurrentSync();
|
|
18523
|
+
*
|
|
18524
|
+
* // Print embedded views
|
|
18525
|
+
* win.print({ content: 'views' });
|
|
18526
|
+
*
|
|
18527
|
+
* // Print screenshot of current window
|
|
18528
|
+
* win.print({ content: 'screenshot' })
|
|
18529
|
+
* ```
|
|
18530
|
+
*
|
|
18531
|
+
* When `content` is set to `views`, the embedded views in the platform window will be concatenated and printed as
|
|
18532
|
+
* individual pages. If `includeSelf` is set to `true`, the platform window itself will be printed as the first
|
|
18533
|
+
* page - be aware that this page will *not* include the embedded views - it will only include the contents of
|
|
18534
|
+
* the platform window itself (e.g. tab stacks), with blank spaces where the view contents would be embedded.
|
|
18535
|
+
*
|
|
18536
|
+
* Due to a known issue, view contents that are not visible at the time `print` is called will not appear when
|
|
18537
|
+
* printing `contents: views`. This includes views that are obscured behind other active UI elements.
|
|
18538
|
+
*
|
|
18539
|
+
* To print the views embedded in their page context, set `content` to `screenshot`.
|
|
18540
|
+
*/
|
|
18541
|
+
print(options?: OpenFin_2.WindowPrintOptions): Promise<void>;
|
|
18542
|
+
}
|
|
18543
|
+
|
|
18544
|
+
/**
|
|
18545
|
+
* Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
|
|
18546
|
+
* @interface
|
|
18547
|
+
*/
|
|
18548
|
+
declare type WindowAlertRequestedEvent = BaseEvent_3 & {
|
|
18549
|
+
type: 'window-alert-requested';
|
|
18550
|
+
};
|
|
18551
|
+
|
|
18552
|
+
/**
|
|
18553
|
+
* Returned from getBounds call. bottom and right are never used for setting.
|
|
18554
|
+
* @interface
|
|
18555
|
+
*/
|
|
18556
|
+
declare type WindowBounds = Bounds & {
|
|
18557
|
+
bottom: number;
|
|
18558
|
+
right: number;
|
|
18559
|
+
};
|
|
18560
|
+
|
|
18561
|
+
/**
|
|
18562
|
+
* @deprecated Renamed to {@link ClosedEvent}.
|
|
18563
|
+
*/
|
|
18564
|
+
declare type WindowClosedEvent = ClosedEvent_2;
|
|
18565
|
+
|
|
18566
|
+
/**
|
|
18567
|
+
* @deprecated Renamed to {@link CloseRequestedEvent}.
|
|
18568
|
+
*/
|
|
18569
|
+
declare type WindowCloseRequestedEvent = CloseRequestedEvent;
|
|
18570
|
+
|
|
18571
|
+
/**
|
|
18572
|
+
* @deprecated Renamed to {@link ClosingEvent}.
|
|
18573
|
+
*/
|
|
18574
|
+
declare type WindowClosingEvent = ClosingEvent;
|
|
18575
|
+
|
|
18576
|
+
/**
|
|
18577
|
+
* A rule prescribing content creation in a {@link OpenFin.Window}.
|
|
18578
|
+
*
|
|
18579
|
+
* @interface
|
|
18580
|
+
*/
|
|
18581
|
+
declare type WindowContentCreationRule = BaseContentCreationRule & {
|
|
18582
|
+
/**
|
|
18583
|
+
* Behavior to use when opening matched content.
|
|
18584
|
+
*/
|
|
18585
|
+
behavior: 'window';
|
|
18586
|
+
/**
|
|
18587
|
+
* Options for newly-created window.
|
|
18588
|
+
*/
|
|
18589
|
+
options?: Partial<WindowOptions>;
|
|
18590
|
+
};
|
|
18591
|
+
|
|
18592
|
+
/**
|
|
18593
|
+
* Generated when a child window is created.
|
|
18594
|
+
* @interface
|
|
18595
|
+
*/
|
|
18596
|
+
declare type WindowCreatedEvent = BaseEvent_3 & {
|
|
18597
|
+
type: 'window-created';
|
|
18598
|
+
};
|
|
18599
|
+
|
|
18600
|
+
/**
|
|
18601
|
+
* Options required to create a new window with {@link Window._WindowModule.create Window.create}.
|
|
18602
|
+
*
|
|
18603
|
+
* Note that `name` is the only required property — albeit the `url` property is usually provided as well
|
|
18604
|
+
* (defaults to `"about:blank"` when omitted).
|
|
18605
|
+
* @interface
|
|
18606
|
+
*/
|
|
18607
|
+
declare type WindowCreationOptions = Partial<WindowOptions> & {
|
|
18608
|
+
name: string;
|
|
18609
|
+
};
|
|
18610
|
+
|
|
18611
|
+
declare type WindowCreationReason = 'tearout' | 'create-view-without-target' | 'api-call' | 'app-creation' | 'restore' | 'apply-snapshot';
|
|
18612
|
+
|
|
18613
|
+
/**
|
|
18614
|
+
* @interface
|
|
18615
|
+
*/
|
|
18616
|
+
declare type WindowDetail = {
|
|
18617
|
+
/**
|
|
18618
|
+
* The bottom-most coordinate of the window.
|
|
18619
|
+
*/
|
|
18620
|
+
bottom: number;
|
|
18621
|
+
/**
|
|
18622
|
+
* The height of the window.
|
|
18623
|
+
*/
|
|
18624
|
+
height: number;
|
|
18625
|
+
isShowing: boolean;
|
|
18626
|
+
/**
|
|
18627
|
+
* The left-most coordinate of the window.
|
|
18628
|
+
*/
|
|
18629
|
+
left: number;
|
|
18630
|
+
/**
|
|
18631
|
+
* The name of the window.
|
|
18632
|
+
*/
|
|
18633
|
+
name: string;
|
|
18634
|
+
/**
|
|
18635
|
+
* The right-most coordinate of the window.
|
|
18636
|
+
*/
|
|
18637
|
+
right: number;
|
|
18638
|
+
state: string;
|
|
18639
|
+
/**
|
|
18640
|
+
* The top-most coordinate of the window.
|
|
18641
|
+
*/
|
|
18642
|
+
top: number;
|
|
18643
|
+
/**
|
|
18644
|
+
* The width of the window.
|
|
18645
|
+
*/
|
|
18646
|
+
width: number;
|
|
18647
|
+
};
|
|
18648
|
+
|
|
18649
|
+
/**
|
|
18650
|
+
* Generated when a child window ends loading.
|
|
18651
|
+
* @interface
|
|
18652
|
+
*/
|
|
18653
|
+
declare type WindowEndLoadEvent = BaseEvent_3 & {
|
|
18654
|
+
type: 'window-end-load';
|
|
18655
|
+
};
|
|
18656
|
+
|
|
18657
|
+
/**
|
|
18658
|
+
* @deprecated, Renamed to {@link Event}.
|
|
18659
|
+
*/
|
|
18660
|
+
declare type WindowEvent = Event_6;
|
|
18661
|
+
|
|
18662
|
+
declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
|
|
18663
|
+
|
|
18664
|
+
declare namespace WindowEvents {
|
|
18665
|
+
export {
|
|
18666
|
+
BaseEvent_5 as BaseEvent,
|
|
18667
|
+
BaseWindowEvent,
|
|
18668
|
+
ViewAttachedEvent,
|
|
18669
|
+
ViewDetachedEvent,
|
|
18670
|
+
WindowViewEvent,
|
|
18671
|
+
AlertRequestedEvent,
|
|
18672
|
+
AuthRequestedEvent,
|
|
18673
|
+
EndLoadEvent,
|
|
18674
|
+
WillRedirectEvent,
|
|
18675
|
+
ReloadedEvent,
|
|
18676
|
+
OptionsChangedEvent,
|
|
18677
|
+
WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
|
|
18678
|
+
ExternalProcessExitedEvent,
|
|
18679
|
+
ExternalProcessStartedEvent,
|
|
18680
|
+
HiddenEvent_2 as HiddenEvent,
|
|
18681
|
+
WindowHiddenEvent,
|
|
18682
|
+
PreloadScriptInfoRunning,
|
|
18683
|
+
PreloadScriptInfo,
|
|
18684
|
+
PreloadScriptsStateChangeEvent,
|
|
18685
|
+
UserBoundsChangeEvent,
|
|
18686
|
+
BoundsChangeEvent,
|
|
18687
|
+
WillMoveOrResizeEvent,
|
|
18688
|
+
PerformanceReportEvent,
|
|
18689
|
+
InputEvent_2 as InputEvent,
|
|
18690
|
+
LayoutInitializedEvent,
|
|
18691
|
+
LayoutReadyEvent,
|
|
18692
|
+
BeginUserBoundsChangingEvent,
|
|
18693
|
+
BoundsChangedEvent,
|
|
18694
|
+
BoundsChangingEvent,
|
|
18695
|
+
CloseRequestedEvent,
|
|
18696
|
+
WindowCloseRequestedEvent,
|
|
18697
|
+
ContextChangedEvent,
|
|
18698
|
+
ClosedEvent_2 as ClosedEvent,
|
|
18699
|
+
WindowClosedEvent,
|
|
18700
|
+
ClosingEvent,
|
|
18701
|
+
WindowClosingEvent,
|
|
18702
|
+
DisabledMovementBoundsChangedEvent,
|
|
18703
|
+
DisabledMovementBoundsChangingEvent,
|
|
18704
|
+
EmbeddedEvent,
|
|
18705
|
+
EndUserBoundsChangingEvent,
|
|
18706
|
+
HotkeyEvent_2 as HotkeyEvent,
|
|
18707
|
+
WindowHotkeyEvent,
|
|
18708
|
+
InitializedEvent_2 as InitializedEvent,
|
|
18709
|
+
WindowInitializedEvent,
|
|
18710
|
+
MaximizedEvent,
|
|
18711
|
+
MinimizedEvent,
|
|
18712
|
+
PreloadScriptsStateChangedEvent,
|
|
18713
|
+
PreloadScriptsStateChangingEvent,
|
|
18714
|
+
RestoredEvent,
|
|
18715
|
+
WindowRestoredEvent,
|
|
18716
|
+
ShowRequestedEvent,
|
|
18717
|
+
WindowShowRequestedEvent,
|
|
18718
|
+
ShownEvent_2 as ShownEvent,
|
|
18719
|
+
WindowShownEvent,
|
|
18720
|
+
UserMovementEnabledEvent,
|
|
18721
|
+
UserMovementDisabledEvent,
|
|
18722
|
+
WillMoveEvent,
|
|
18723
|
+
WillResizeEvent,
|
|
18724
|
+
NonPropagatedWindowEvent,
|
|
18725
|
+
ShowAllDownloadsEvent,
|
|
18726
|
+
DownloadShelfVisibilityChangedEvent,
|
|
18727
|
+
WindowSourcedEvent,
|
|
18728
|
+
WillPropagateWindowEvent,
|
|
18729
|
+
Event_6 as Event,
|
|
18730
|
+
WindowEvent,
|
|
18731
|
+
EventType_2 as EventType,
|
|
18732
|
+
WindowEventType,
|
|
18733
|
+
PropagatedEvent_3 as PropagatedEvent,
|
|
18734
|
+
PropagatedWindowEvent,
|
|
18735
|
+
PropagatedWindowEventType,
|
|
18736
|
+
Payload_3 as Payload,
|
|
18737
|
+
ByType_2 as ByType
|
|
18738
|
+
}
|
|
18739
|
+
}
|
|
18740
|
+
|
|
18741
|
+
/**
|
|
18742
|
+
* @deprecated Renamed to {@link EventType}.
|
|
18743
|
+
*/
|
|
18744
|
+
declare type WindowEventType = WindowEvent['type'];
|
|
18745
|
+
|
|
18746
|
+
/**
|
|
18747
|
+
* @deprecated Renamed to {@link HiddenEvent}.
|
|
18748
|
+
*/
|
|
18749
|
+
declare type WindowHiddenEvent = HiddenEvent_2;
|
|
18750
|
+
|
|
18751
|
+
/**
|
|
18752
|
+
* @deprecated Renamed to {@link HotkeyEvent}.
|
|
18753
|
+
*/
|
|
18754
|
+
declare type WindowHotkeyEvent = HotkeyEvent_2;
|
|
18755
|
+
|
|
18756
|
+
/**
|
|
18757
|
+
* @interface
|
|
18758
|
+
*/
|
|
18759
|
+
declare type WindowInfo = {
|
|
18760
|
+
canNavigateBack: boolean;
|
|
18761
|
+
canNavigateForward: boolean;
|
|
18762
|
+
preloadScripts: Array<any>;
|
|
18763
|
+
title: string;
|
|
18764
|
+
url: string;
|
|
18765
|
+
};
|
|
18766
|
+
|
|
18767
|
+
/**
|
|
18768
|
+
* @deprecated Renamed to {@link InitializedEvent}.
|
|
18769
|
+
*/
|
|
18770
|
+
declare type WindowInitializedEvent = InitializedEvent_2;
|
|
18771
|
+
|
|
18772
|
+
/**
|
|
18773
|
+
* Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
|
|
18774
|
+
*/
|
|
18775
|
+
declare class _WindowModule extends Base {
|
|
18776
|
+
/**
|
|
18777
|
+
* Asynchronously returns a Window object that represents an existing window.
|
|
18778
|
+
*
|
|
18779
|
+
* @example
|
|
18780
|
+
* ```js
|
|
18781
|
+
* async function createWin() {
|
|
18782
|
+
* const app = await fin.Application.start({
|
|
18783
|
+
* name: 'myApp',
|
|
18784
|
+
* uuid: 'app-1',
|
|
18785
|
+
* url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrap.html',
|
|
18786
|
+
* autoShow: true
|
|
18787
|
+
* });
|
|
18788
|
+
* return await app.getWindow();
|
|
18789
|
+
* }
|
|
18790
|
+
* createWin().then(() => fin.Window.wrap({ uuid: 'app-1', name: 'myApp' }))
|
|
18791
|
+
* .then(win => console.log('wrapped window'))
|
|
18792
|
+
* .catch(err => console.log(err));
|
|
18793
|
+
* ```
|
|
18794
|
+
*/
|
|
18795
|
+
wrap(identity: OpenFin_2.Identity): Promise<OpenFin_2.Window>;
|
|
18796
|
+
/**
|
|
18797
|
+
* Synchronously returns a Window object that represents an existing window.
|
|
18798
|
+
*
|
|
18799
|
+
* @example
|
|
18800
|
+
* ```js
|
|
18801
|
+
* async function createWin() {
|
|
18802
|
+
* const app = await fin.Application.start({
|
|
18803
|
+
* name: 'myApp',
|
|
18804
|
+
* uuid: 'app-1',
|
|
18805
|
+
* url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrapSync.html',
|
|
18806
|
+
* autoShow: true
|
|
18807
|
+
* });
|
|
18808
|
+
* return await app.getWindow();
|
|
18809
|
+
* }
|
|
18810
|
+
* await createWin();
|
|
18811
|
+
* let win = fin.Window.wrapSync({ uuid: 'app-1', name: 'myApp' });
|
|
18812
|
+
* ```
|
|
18813
|
+
*/
|
|
18814
|
+
wrapSync(identity: OpenFin_2.Identity): OpenFin_2.Window;
|
|
18815
|
+
/**
|
|
18816
|
+
* Creates a new Window.
|
|
18817
|
+
* @param options - Window creation options
|
|
18818
|
+
*
|
|
18819
|
+
* @example
|
|
18820
|
+
* ```js
|
|
18821
|
+
* async function createWindow() {
|
|
18822
|
+
* const winOption = {
|
|
18823
|
+
* name:'child',
|
|
18824
|
+
* defaultWidth: 300,
|
|
18825
|
+
* defaultHeight: 300,
|
|
18826
|
+
* url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.create.html',
|
|
18827
|
+
* frame: true,
|
|
18828
|
+
* autoShow: true
|
|
18829
|
+
* };
|
|
18830
|
+
* return await fin.Window.create(winOption);
|
|
18831
|
+
* }
|
|
18832
|
+
*
|
|
18833
|
+
* createWindow().then(() => console.log('Window is created')).catch(err => console.log(err));
|
|
18834
|
+
* ```
|
|
18835
|
+
*/
|
|
18836
|
+
create(options: OpenFin_2.WindowCreationOptions): Promise<OpenFin_2.Window>;
|
|
18837
|
+
/**
|
|
18838
|
+
* Asynchronously returns a Window object that represents the current window
|
|
18839
|
+
*
|
|
18840
|
+
* @example
|
|
18841
|
+
* ```js
|
|
18842
|
+
* fin.Window.getCurrent()
|
|
18843
|
+
* .then(wnd => console.log('current window'))
|
|
18844
|
+
* .catch(err => console.log(err));
|
|
18845
|
+
*
|
|
18846
|
+
* ```
|
|
18847
|
+
*/
|
|
18848
|
+
getCurrent(): Promise<OpenFin_2.Window>;
|
|
18849
|
+
/**
|
|
18850
|
+
* Synchronously returns a Window object that represents the current window
|
|
18851
|
+
*
|
|
18852
|
+
* @example
|
|
18853
|
+
* ```js
|
|
18854
|
+
* const wnd = fin.Window.getCurrentSync();
|
|
18855
|
+
* const info = await wnd.getInfo();
|
|
18856
|
+
* console.log(info);
|
|
18857
|
+
*
|
|
18858
|
+
* ```
|
|
18859
|
+
*/
|
|
18860
|
+
getCurrentSync(): OpenFin_2.Window;
|
|
18861
|
+
}
|
|
18862
|
+
|
|
18863
|
+
/**
|
|
18864
|
+
* Generated when a child window is not responding.
|
|
18865
|
+
* @interface
|
|
18866
|
+
*/
|
|
18867
|
+
declare type WindowNotRespondingEvent = BaseEvent_3 & {
|
|
18868
|
+
type: 'window-not-responding';
|
|
18869
|
+
};
|
|
18870
|
+
|
|
18871
|
+
/**
|
|
18872
|
+
* @interface
|
|
18873
|
+
*/
|
|
18874
|
+
declare type WindowOptionDiff = {
|
|
18875
|
+
[key in keyof WindowOptions]: {
|
|
18876
|
+
oldVal: WindowOptions[key];
|
|
18877
|
+
newVal: WindowOptions[key];
|
|
18878
|
+
};
|
|
18879
|
+
};
|
|
18880
|
+
|
|
18881
|
+
/**
|
|
18882
|
+
* @interface
|
|
18883
|
+
*/
|
|
18884
|
+
declare type WindowOptions = MutableWindowOptions & ConstWindowOptions;
|
|
18885
|
+
|
|
18886
|
+
declare type WindowOptionsChangedEvent = OpenFin_2.WindowEvents.WindowOptionsChangedEvent;
|
|
18887
|
+
|
|
18888
|
+
/**
|
|
18889
|
+
* @deprecated Renamed to {@link OptionsChangedEvent}.
|
|
18890
|
+
*/
|
|
18891
|
+
declare type WindowOptionsChangedEvent_2 = OptionsChangedEvent;
|
|
18892
|
+
|
|
18893
|
+
declare type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
|
|
18894
|
+
|
|
18895
|
+
/**
|
|
18896
|
+
* Generated when a child window is responding.
|
|
18897
|
+
* @interface
|
|
18898
|
+
*/
|
|
18899
|
+
declare type WindowRespondingEvent = BaseEvent_3 & {
|
|
18900
|
+
type: 'window-responding';
|
|
18901
|
+
};
|
|
18902
|
+
|
|
18903
|
+
/**
|
|
18904
|
+
* @deprecated Renamed to {@link RestoredEvent}.
|
|
18905
|
+
*/
|
|
18906
|
+
declare type WindowRestoredEvent = RestoredEvent;
|
|
18907
|
+
|
|
18908
|
+
/**
|
|
18909
|
+
* @deprecated Renamed to {@link ShownEvent}.
|
|
18910
|
+
*/
|
|
18911
|
+
declare type WindowShownEvent = ShownEvent_2;
|
|
18912
|
+
|
|
18913
|
+
/**
|
|
18914
|
+
* @deprecated Renamed to {@link ShowRequestedEvent}.
|
|
18915
|
+
*/
|
|
18916
|
+
declare type WindowShowRequestedEvent = ShowRequestedEvent;
|
|
18917
|
+
|
|
18918
|
+
/**
|
|
18919
|
+
* A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
|
|
18920
|
+
* from {@link OpenFin.ViewEvents}.
|
|
18921
|
+
*/
|
|
18922
|
+
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;
|
|
18923
|
+
|
|
18924
|
+
/**
|
|
18925
|
+
* Generated when a child window starts loading.
|
|
18926
|
+
* @interface
|
|
18927
|
+
*/
|
|
18928
|
+
declare type WindowStartLoadEvent = BaseEvent_3 & {
|
|
18929
|
+
type: 'window-start-load';
|
|
18930
|
+
};
|
|
18931
|
+
|
|
18932
|
+
/**
|
|
18933
|
+
* Visibility state of a window.
|
|
18934
|
+
*/
|
|
18935
|
+
declare type WindowState = 'maximized' | 'minimized' | 'normal';
|
|
18936
|
+
|
|
18937
|
+
/**
|
|
18938
|
+
* A view-related event that fires natively on the `Window` topic. This means that these events *do* propagate
|
|
18939
|
+
* to the `Application` level, with the name pattern `window-view-eventname`.
|
|
18940
|
+
*/
|
|
18941
|
+
declare type WindowViewEvent = {
|
|
18942
|
+
viewIdentity: OpenFin_2.Identity;
|
|
18943
|
+
} & (ViewAttachedEvent | ViewDetachedEvent);
|
|
18944
|
+
|
|
18945
|
+
/**
|
|
18946
|
+
* @interface
|
|
18947
|
+
*/
|
|
18948
|
+
declare type WindowViewsPrintOptions = {
|
|
18949
|
+
content: 'views';
|
|
18950
|
+
includeSelf?: boolean;
|
|
18951
|
+
};
|
|
18952
|
+
|
|
18953
|
+
declare type Wire = EventEmitter & {
|
|
18954
|
+
connect(messageReciever: MessageReceiver): Promise<any>;
|
|
18955
|
+
connectSync(): any;
|
|
18956
|
+
send(data: any): Promise<any>;
|
|
18957
|
+
shutdown(): Promise<void>;
|
|
18958
|
+
getPort(): string;
|
|
18959
|
+
};
|
|
18960
|
+
|
|
18961
|
+
declare type WireConstructor = {
|
|
18962
|
+
new (onmessage: (data: any) => void): Wire;
|
|
18963
|
+
};
|
|
18964
|
+
|
|
18965
|
+
/**
|
|
18966
|
+
* @internal
|
|
18967
|
+
*/
|
|
18968
|
+
declare type WithId<T extends AppVersionEventType> = `${T}.${string}`;
|
|
18969
|
+
|
|
18970
|
+
declare interface WithInterop {
|
|
18971
|
+
interop: InteropClient;
|
|
18972
|
+
}
|
|
18973
|
+
|
|
18974
|
+
/**
|
|
18975
|
+
* @internal
|
|
18976
|
+
*/
|
|
18977
|
+
declare type WithoutId<T extends string> = T extends WithId<infer U> ? U : never;
|
|
18978
|
+
|
|
18979
|
+
declare type WithPositioningOptions<T extends {} = {}> = T & {
|
|
18980
|
+
positioningOptions?: OpenFin_2.PositioningOptions;
|
|
18981
|
+
};
|
|
18982
|
+
|
|
18983
|
+
/**
|
|
18984
|
+
* @internal
|
|
18985
|
+
* @interface
|
|
18986
|
+
*/
|
|
18987
|
+
declare type WorkspacePlatformOptions = {
|
|
18988
|
+
/** Leaving this as any for now until we figure out what the shape should look like in Workspace */
|
|
18989
|
+
[key: string]: any;
|
|
18990
|
+
};
|
|
18991
|
+
|
|
18992
|
+
/**
|
|
18993
|
+
* A generic request to write any supported data to the clipboard.
|
|
18994
|
+
* @interface
|
|
18995
|
+
*/
|
|
18996
|
+
declare type WriteAnyClipboardRequest = BaseClipboardRequest & {
|
|
18997
|
+
/**
|
|
18998
|
+
* Data to be written
|
|
18999
|
+
*/
|
|
19000
|
+
data: {
|
|
19001
|
+
text?: string;
|
|
19002
|
+
html?: string;
|
|
19003
|
+
rtf?: string;
|
|
19004
|
+
} & Partial<Pick<WriteImageClipboardRequest, 'image'>>;
|
|
19005
|
+
};
|
|
19006
|
+
|
|
19007
|
+
/**
|
|
19008
|
+
* @deprecated - instead use WriteAnyClipboardRequest
|
|
19009
|
+
*
|
|
19010
|
+
* A generic request to write any supported data to the clipboard.
|
|
19011
|
+
*
|
|
19012
|
+
* @interface
|
|
19013
|
+
*/
|
|
19014
|
+
declare type WriteAnyRequestType = WriteAnyClipboardRequest;
|
|
19015
|
+
|
|
19016
|
+
/**
|
|
19017
|
+
* A request to write data to the clipboard.
|
|
19018
|
+
* @interface
|
|
19019
|
+
*/
|
|
19020
|
+
declare type WriteClipboardRequest = BaseClipboardRequest & {
|
|
19021
|
+
/**
|
|
19022
|
+
* Data to write to the clipboard.
|
|
19023
|
+
*/
|
|
19024
|
+
data: string;
|
|
19025
|
+
};
|
|
19026
|
+
|
|
19027
|
+
/**
|
|
19028
|
+
* @interface
|
|
19029
|
+
*/
|
|
19030
|
+
declare type WriteImageClipboardRequest = BaseClipboardRequest & {
|
|
19031
|
+
/**
|
|
19032
|
+
* Can be either a base64 string, or a DataURL string. If using DataURL, the
|
|
19033
|
+
* supported formats are `data:image/png[;base64],` and `data:image/jpeg[;base64],`.
|
|
19034
|
+
* Using other image/<format> DataURLs will throw an Error.
|
|
19035
|
+
*/
|
|
19036
|
+
image: string;
|
|
19037
|
+
};
|
|
19038
|
+
|
|
19039
|
+
/**
|
|
19040
|
+
* @deprecated - instead use OpenFin.WriteClipboardRequest
|
|
19041
|
+
*
|
|
19042
|
+
* A request to write data to the clipboard.
|
|
19043
|
+
*
|
|
19044
|
+
* @interface
|
|
19045
|
+
*/
|
|
19046
|
+
declare type WriteRequestType = WriteClipboardRequest;
|
|
19047
|
+
|
|
19048
|
+
export { }
|