@openfin/core 31.74.5 → 31.74.6
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/package.json +1 -1
- package/src/OpenFin.d.ts +238 -238
- package/src/OpenFin.js +0 -2
- package/src/api/base.d.ts +2 -2
- package/src/api/events/application.d.ts +22 -22
- package/src/api/events/base.d.ts +6 -6
- package/src/api/events/channel.d.ts +5 -5
- package/src/api/events/emitterMap.d.ts +1 -1
- package/src/api/events/externalApplication.d.ts +3 -3
- package/src/api/events/frame.d.ts +5 -5
- package/src/api/events/globalHotkey.d.ts +3 -3
- package/src/api/events/platform.d.ts +3 -3
- package/src/api/events/system.d.ts +17 -17
- package/src/api/events/typedEventEmitter.d.ts +1 -1
- package/src/api/events/view.d.ts +13 -13
- package/src/api/events/webcontents.d.ts +22 -22
- package/src/api/events/window.d.ts +49 -49
- package/src/api/fin.d.ts +1 -1
- package/src/api/frame/Instance.d.ts +1 -1
- package/src/api/interappbus/channel/channel.d.ts +4 -4
- package/src/api/interappbus/channel/channel.js +3 -3
- package/src/api/interappbus/channel/client.d.ts +2 -2
- package/src/api/interappbus/channel/client.js +20 -20
- package/src/api/interappbus/channel/connection-manager.d.ts +1 -1
- package/src/api/interappbus/channel/connection-manager.js +12 -12
- package/src/api/interappbus/channel/index.d.ts +2 -2
- package/src/api/interappbus/channel/protocols/classic/strategy.d.ts +1 -1
- package/src/api/interappbus/channel/protocols/combined/strategy.d.ts +2 -2
- package/src/api/interappbus/channel/protocols/combined/strategy.js +5 -5
- package/src/api/interappbus/channel/protocols/index.d.ts +4 -4
- package/src/api/interappbus/channel/protocols/rtc/endpoint.d.ts +1 -1
- package/src/api/interappbus/channel/protocols/rtc/strategy.d.ts +1 -1
- package/src/api/interappbus/channel/protocols/strategy-types.d.ts +4 -4
- package/src/api/interappbus/channel/protocols/strategy.d.ts +3 -3
- package/src/api/interappbus/channel/provider.d.ts +5 -5
- package/src/api/interappbus/channel/provider.js +24 -24
- package/src/api/interop/InteropBroker.d.ts +1 -1
- package/src/api/interop/fdc3/PrivateChannelClient.d.ts +1 -1
- package/src/api/interop/fdc3/PrivateChannelProvider.d.ts +1 -1
- package/src/api/interop/fdc3/shapes/fdc3v1.d.ts +3 -3
- package/src/api/interop/fdc3/shapes/fdc3v2.d.ts +4 -4
- package/src/api/interop/fdc3/versions.d.ts +1 -1
- package/src/api/me.d.ts +3 -3
- package/src/api/platform/common-utils.d.ts +1 -1
- package/src/api/platform/layout/Factory.d.ts +1 -1
- package/src/api/platform/layout/Instance.d.ts +3 -3
- package/src/api/platform/layout/controllers/splitter-controller.d.ts +1 -1
- package/src/api/platform/layout/shapes.d.ts +1 -1
- package/src/api/system/index.d.ts +13 -13
- package/src/api/view/Instance.d.ts +1 -1
- package/src/environment/browser.d.ts +1 -1
- package/src/environment/environment.d.ts +1 -1
- package/src/environment/node-env.d.ts +1 -1
- package/src/environment/openfin-env.d.ts +1 -1
- package/src/shapes/ERROR_BOX_TYPES.d.ts +1 -1
- package/src/shapes/protocol.d.ts +3 -3
- package/src/transport/transport-errors.d.ts +2 -2
- package/src/transport/transport.d.ts +3 -3
- package/src/transport/wire.d.ts +13 -13
- package/src/util/errors.d.ts +2 -2
- package/src/util/http.js +4 -2
- package/src/util/promises.d.ts +1 -1
- package/src/util/utilTypes.d.ts +1 -1
package/src/OpenFin.d.ts
CHANGED
|
@@ -14,14 +14,14 @@ import { PlatformProvider } from './api/platform/provider';
|
|
|
14
14
|
import { SnapshotSource } from './api/snapshot-source';
|
|
15
15
|
import type { View } from './api/view';
|
|
16
16
|
import { _Window } from './api/window';
|
|
17
|
-
export
|
|
17
|
+
export type Fin<MeType extends EntityType = 'window' | 'view'> = FinApi<MeType>;
|
|
18
18
|
export type { Application, ExternalApplication, _Frame as Frame, ChannelClient, ChannelProvider, Platform, Layout, View, _Window as Window, InteropClient, InteropBroker, SnapshotSource };
|
|
19
|
-
export
|
|
19
|
+
export type WebContent = View | _Window;
|
|
20
20
|
export type { PlatformProvider };
|
|
21
|
-
export
|
|
21
|
+
export type ApplicationIdentity = {
|
|
22
22
|
uuid: string;
|
|
23
23
|
};
|
|
24
|
-
export
|
|
24
|
+
export type Identity = {
|
|
25
25
|
/**
|
|
26
26
|
* Universally unique identifier of the compenent
|
|
27
27
|
*/
|
|
@@ -34,7 +34,7 @@ export declare type Identity = {
|
|
|
34
34
|
/**
|
|
35
35
|
* Identity of a channel client
|
|
36
36
|
*/
|
|
37
|
-
export
|
|
37
|
+
export type ClientIdentity = Identity & {
|
|
38
38
|
/**
|
|
39
39
|
* Unique identifier for a client, because there can be multiple clients at one name/uuid entity.
|
|
40
40
|
*/
|
|
@@ -44,7 +44,7 @@ export declare type ClientIdentity = Identity & {
|
|
|
44
44
|
/**
|
|
45
45
|
* Extended channel client information
|
|
46
46
|
*/
|
|
47
|
-
export
|
|
47
|
+
export type ClientInfo = Omit<ClientIdentity, 'isLocalEndpointId'> & {
|
|
48
48
|
/**
|
|
49
49
|
* Indicates if the client belongs to a Window or View
|
|
50
50
|
*/
|
|
@@ -54,16 +54,16 @@ export declare type ClientInfo = Omit<ClientIdentity, 'isLocalEndpointId'> & {
|
|
|
54
54
|
*/
|
|
55
55
|
connectionUrl: string;
|
|
56
56
|
};
|
|
57
|
-
export
|
|
57
|
+
export type ClientIdentityMultiRuntime = ClientIdentity & {
|
|
58
58
|
runtimeUuid: string;
|
|
59
59
|
};
|
|
60
|
-
export
|
|
60
|
+
export type EntityInfo = {
|
|
61
61
|
uuid: string;
|
|
62
62
|
name: string;
|
|
63
63
|
entityType: EntityType;
|
|
64
64
|
};
|
|
65
|
-
export
|
|
66
|
-
export
|
|
65
|
+
export type EntityType = 'window' | 'iframe' | 'external connection' | 'view' | 'unknown';
|
|
66
|
+
export type Bounds = {
|
|
67
67
|
top: number;
|
|
68
68
|
left: number;
|
|
69
69
|
height: number;
|
|
@@ -72,14 +72,14 @@ export declare type Bounds = {
|
|
|
72
72
|
/**
|
|
73
73
|
* Returned from getBounds call. bottom and right are never used for setting.
|
|
74
74
|
*/
|
|
75
|
-
export
|
|
75
|
+
export type WindowBounds = Bounds & {
|
|
76
76
|
bottom: number;
|
|
77
77
|
right: number;
|
|
78
78
|
};
|
|
79
79
|
/**
|
|
80
80
|
* A rectangular area on the screen.
|
|
81
81
|
*/
|
|
82
|
-
export
|
|
82
|
+
export type Rectangle = {
|
|
83
83
|
/**
|
|
84
84
|
* The x coordinate of the rectangle's origin in pixels
|
|
85
85
|
*/
|
|
@@ -112,14 +112,14 @@ export declare type Rectangle = {
|
|
|
112
112
|
* This object inherits all the properties of the window creation {@link Window~options options} object,
|
|
113
113
|
* which will take priority over those of the same name that may be provided in `mainWindowOptions`.
|
|
114
114
|
*/
|
|
115
|
-
export
|
|
115
|
+
export type ApplicationCreationOptions = Partial<ApplicationOptions> & {
|
|
116
116
|
name: string;
|
|
117
117
|
uuid: string;
|
|
118
118
|
};
|
|
119
119
|
/**
|
|
120
120
|
* The complete set of options for an application.
|
|
121
121
|
*/
|
|
122
|
-
export
|
|
122
|
+
export type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
123
123
|
/**
|
|
124
124
|
* @defaultValue false
|
|
125
125
|
*
|
|
@@ -213,11 +213,11 @@ export declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
213
213
|
enableJumpList: boolean;
|
|
214
214
|
enableBeforeUnload: boolean;
|
|
215
215
|
};
|
|
216
|
-
export
|
|
216
|
+
export type InteropBrokerOptions = {
|
|
217
217
|
contextGroups?: ContextGroupInfo;
|
|
218
218
|
logging?: InteropLoggingOptions;
|
|
219
219
|
};
|
|
220
|
-
export
|
|
220
|
+
export type ContextGroupInfo = {
|
|
221
221
|
/**
|
|
222
222
|
* Name of the context group.
|
|
223
223
|
*/
|
|
@@ -230,7 +230,7 @@ export declare type ContextGroupInfo = {
|
|
|
230
230
|
/**
|
|
231
231
|
* The display data for a context group.
|
|
232
232
|
*/
|
|
233
|
-
export
|
|
233
|
+
export type DisplayMetadata = {
|
|
234
234
|
/**
|
|
235
235
|
* A user-readable name for this context group, e.g: `"Red"`
|
|
236
236
|
*/
|
|
@@ -244,8 +244,8 @@ export declare type DisplayMetadata = {
|
|
|
244
244
|
*/
|
|
245
245
|
readonly glyph?: string;
|
|
246
246
|
};
|
|
247
|
-
export
|
|
248
|
-
export
|
|
247
|
+
export type LegacyWinOptionsInAppOptions = Pick<WindowCreationOptions, 'accelerator' | 'alwaysOnTop' | 'api' | 'aspectRatio' | 'autoplayPolicy' | 'autoShow' | 'backgroundColor' | 'contentNavigation' | 'contextMenu' | 'cornerRounding' | 'customData' | 'customRequestHeaders' | 'defaultCentered' | 'defaultHeight' | 'defaultLeft' | 'defaultTop' | 'defaultWidth' | 'frame' | 'hideOnClose' | 'icon' | 'maxHeight' | 'maximizable' | 'maxWidth' | 'minHeight' | 'minimizable' | 'minWidth' | 'opacity' | 'preloadScripts' | 'resizable' | 'resizeRegion' | 'saveWindowState' | 'ignoreSavedWindowState' | 'shadow' | 'showTaskbarIcon' | 'smallWindow' | 'state' | 'taskbarIconGroup' | 'waitForPageLoad'>;
|
|
248
|
+
export type Snapshot = {
|
|
249
249
|
windows: WindowCreationOptions[];
|
|
250
250
|
snapshotDetails?: {
|
|
251
251
|
monitorInfo: MonitorInfo;
|
|
@@ -256,7 +256,7 @@ export declare type Snapshot = {
|
|
|
256
256
|
contextGroupStates: ContextGroupStates;
|
|
257
257
|
};
|
|
258
258
|
};
|
|
259
|
-
export
|
|
259
|
+
export type ContextGroupStates = {
|
|
260
260
|
[key: string]: {
|
|
261
261
|
[key: string]: Context;
|
|
262
262
|
};
|
|
@@ -264,7 +264,7 @@ export declare type ContextGroupStates = {
|
|
|
264
264
|
/**
|
|
265
265
|
* Data passed between entities and applications.
|
|
266
266
|
*/
|
|
267
|
-
export
|
|
267
|
+
export type Context = {
|
|
268
268
|
/**
|
|
269
269
|
* An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
|
|
270
270
|
*/
|
|
@@ -280,7 +280,7 @@ export declare type Context = {
|
|
|
280
280
|
*/
|
|
281
281
|
type: string;
|
|
282
282
|
};
|
|
283
|
-
export
|
|
283
|
+
export type MonitorInfo = {
|
|
284
284
|
/**
|
|
285
285
|
* The device scale factor.
|
|
286
286
|
*/
|
|
@@ -298,7 +298,7 @@ export declare type MonitorInfo = {
|
|
|
298
298
|
*/
|
|
299
299
|
virtualScreen: DipRect;
|
|
300
300
|
};
|
|
301
|
-
export
|
|
301
|
+
export type Point = {
|
|
302
302
|
/**
|
|
303
303
|
* The mouse x position
|
|
304
304
|
*/
|
|
@@ -308,7 +308,7 @@ export declare type Point = {
|
|
|
308
308
|
*/
|
|
309
309
|
y: number;
|
|
310
310
|
};
|
|
311
|
-
export
|
|
311
|
+
export type PointTopLeft = {
|
|
312
312
|
/**
|
|
313
313
|
* The mouse top position in virtual screen coordinates
|
|
314
314
|
*/
|
|
@@ -318,13 +318,13 @@ export declare type PointTopLeft = {
|
|
|
318
318
|
*/
|
|
319
319
|
left: number;
|
|
320
320
|
};
|
|
321
|
-
export
|
|
321
|
+
export type RectangleByEdgePositions = {
|
|
322
322
|
top: number;
|
|
323
323
|
left: number;
|
|
324
324
|
bottom: number;
|
|
325
325
|
right: number;
|
|
326
326
|
};
|
|
327
|
-
export
|
|
327
|
+
export type MonitorDetails = {
|
|
328
328
|
/**
|
|
329
329
|
* The available DIP scale coordinates.
|
|
330
330
|
*/
|
|
@@ -359,15 +359,15 @@ export declare type MonitorDetails = {
|
|
|
359
359
|
*/
|
|
360
360
|
monitor: DipScaleRects;
|
|
361
361
|
};
|
|
362
|
-
export
|
|
362
|
+
export type DipRect = RectangleByEdgePositions & {
|
|
363
363
|
dipRect: RectangleByEdgePositions;
|
|
364
364
|
scaledRect: RectangleByEdgePositions;
|
|
365
365
|
};
|
|
366
|
-
export
|
|
366
|
+
export type DipScaleRects = {
|
|
367
367
|
dipRect: RectangleByEdgePositions;
|
|
368
368
|
scaledRect: RectangleByEdgePositions;
|
|
369
369
|
};
|
|
370
|
-
export
|
|
370
|
+
export type TaskBar = DipScaleRects & {
|
|
371
371
|
/**
|
|
372
372
|
* Which edge of a monitor the taskbar is on
|
|
373
373
|
*/
|
|
@@ -383,21 +383,21 @@ export declare type TaskBar = DipScaleRects & {
|
|
|
383
383
|
* Note that `name` is the only required property — albeit the `url` property is usually provided as well
|
|
384
384
|
* (defaults to `"about:blank"` when omitted).
|
|
385
385
|
*/
|
|
386
|
-
export
|
|
386
|
+
export type WindowCreationOptions = Partial<WindowOptions> & {
|
|
387
387
|
name: string;
|
|
388
388
|
};
|
|
389
|
-
export
|
|
390
|
-
export
|
|
389
|
+
export type UpdatableWindowOptions = Partial<MutableWindowOptions>;
|
|
390
|
+
export type WindowOptions = MutableWindowOptions & ConstWindowOptions;
|
|
391
391
|
/**
|
|
392
392
|
* Configuration for view visibility settings
|
|
393
393
|
*/
|
|
394
|
-
export
|
|
394
|
+
export type ViewVisibilityOption = {
|
|
395
395
|
enabled?: boolean;
|
|
396
396
|
};
|
|
397
397
|
/**
|
|
398
398
|
* _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
|
|
399
399
|
*/
|
|
400
|
-
export
|
|
400
|
+
export type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
|
|
401
401
|
/**
|
|
402
402
|
* @defaultValue false
|
|
403
403
|
*
|
|
@@ -414,7 +414,7 @@ export declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
|
|
|
414
414
|
/**
|
|
415
415
|
* _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
|
|
416
416
|
*/
|
|
417
|
-
export
|
|
417
|
+
export type ViewVisibilityOptions = {
|
|
418
418
|
/**
|
|
419
419
|
* Enables views to be shown when a Platform Window is being resized by the user.
|
|
420
420
|
*/
|
|
@@ -431,12 +431,12 @@ export declare type ViewVisibilityOptions = {
|
|
|
431
431
|
/**
|
|
432
432
|
* Visibility state of a window.
|
|
433
433
|
*/
|
|
434
|
-
export
|
|
435
|
-
export
|
|
434
|
+
export type WindowState = 'maximized' | 'minimized' | 'normal';
|
|
435
|
+
export type AutoplayPolicyOptions = 'no-user-gesture-required' | 'user-gesture-required' | 'document-user-activation-required';
|
|
436
436
|
/**
|
|
437
437
|
* Window options that cannot be changed after creation.
|
|
438
438
|
*/
|
|
439
|
-
export
|
|
439
|
+
export type ConstWindowOptions = {
|
|
440
440
|
/**
|
|
441
441
|
* Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
|
|
442
442
|
*/
|
|
@@ -629,7 +629,7 @@ export declare type ConstWindowOptions = {
|
|
|
629
629
|
/**
|
|
630
630
|
* Window options that can be changed after window creation.
|
|
631
631
|
*/
|
|
632
|
-
export
|
|
632
|
+
export type MutableWindowOptions = {
|
|
633
633
|
/**
|
|
634
634
|
* Turns anything of matching RGB value transparent.
|
|
635
635
|
*
|
|
@@ -794,7 +794,7 @@ export declare type MutableWindowOptions = {
|
|
|
794
794
|
interop: InteropConfig;
|
|
795
795
|
workspacePlatform: WorkspacePlatformOptions;
|
|
796
796
|
};
|
|
797
|
-
export
|
|
797
|
+
export type WorkspacePlatformOptions = {
|
|
798
798
|
/** Leaving this as any for now until we figure out what the shape should look like in Workspace */
|
|
799
799
|
[key: string]: any;
|
|
800
800
|
};
|
|
@@ -802,13 +802,13 @@ export declare type WorkspacePlatformOptions = {
|
|
|
802
802
|
* Object representing headers and their values, where the
|
|
803
803
|
* object key is the name of header and value key is the value of the header
|
|
804
804
|
*/
|
|
805
|
-
export
|
|
805
|
+
export type WebRequestHeader = {
|
|
806
806
|
[key: string]: string;
|
|
807
807
|
};
|
|
808
808
|
/**
|
|
809
809
|
* Custom headers for requests sent by the window.
|
|
810
810
|
*/
|
|
811
|
-
export
|
|
811
|
+
export type CustomRequestHeaders = {
|
|
812
812
|
/**
|
|
813
813
|
* The URL patterns for which the headers will be applied.
|
|
814
814
|
*/
|
|
@@ -819,7 +819,7 @@ export declare type CustomRequestHeaders = {
|
|
|
819
819
|
*/
|
|
820
820
|
headers: WebRequestHeader[];
|
|
821
821
|
};
|
|
822
|
-
export
|
|
822
|
+
export type WindowOptionDiff = {
|
|
823
823
|
[key in keyof WindowOptions]: {
|
|
824
824
|
oldVal: WindowOptions[key];
|
|
825
825
|
newVal: WindowOptions[key];
|
|
@@ -828,7 +828,7 @@ export declare type WindowOptionDiff = {
|
|
|
828
828
|
/**
|
|
829
829
|
* Defines a region in pixels that will respond to user mouse interaction for resizing a frameless window.
|
|
830
830
|
*/
|
|
831
|
-
export
|
|
831
|
+
export type ResizeRegion = {
|
|
832
832
|
/**
|
|
833
833
|
* @defaultValue 7
|
|
834
834
|
*
|
|
@@ -874,7 +874,7 @@ export declare type ResizeRegion = {
|
|
|
874
874
|
/**
|
|
875
875
|
* Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
|
|
876
876
|
*/
|
|
877
|
-
export
|
|
877
|
+
export type Accelerator = {
|
|
878
878
|
/**
|
|
879
879
|
* If `true`, enables the devtools keyboard shortcut:<br>
|
|
880
880
|
* `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
|
|
@@ -911,7 +911,7 @@ export declare type Accelerator = {
|
|
|
911
911
|
/**
|
|
912
912
|
* Configurations for API injection.
|
|
913
913
|
*/
|
|
914
|
-
export
|
|
914
|
+
export type Api = {
|
|
915
915
|
/**
|
|
916
916
|
* Configure injection of OpenFin API into iframes based on domain
|
|
917
917
|
*/
|
|
@@ -932,7 +932,7 @@ export declare type Api = {
|
|
|
932
932
|
* In the lack of a whitelist, navigation to URLs that match a blacklisted pattern would be prohibited.
|
|
933
933
|
* See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
|
|
934
934
|
*/
|
|
935
|
-
export
|
|
935
|
+
export type ContentNavigation = {
|
|
936
936
|
/**
|
|
937
937
|
* Allowed URLs for navigation.
|
|
938
938
|
*/
|
|
@@ -947,7 +947,7 @@ export declare type ContentNavigation = {
|
|
|
947
947
|
* In the lack of a whitelist, redirects to URLs that match a blacklisted pattern would be prohibited.
|
|
948
948
|
* See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
|
|
949
949
|
*/
|
|
950
|
-
export
|
|
950
|
+
export type ContentRedirect = {
|
|
951
951
|
/**
|
|
952
952
|
* Allowed URLs for redirects.
|
|
953
953
|
*/
|
|
@@ -961,7 +961,7 @@ export declare type ContentRedirect = {
|
|
|
961
961
|
* Defines and applies rounded corners for a frameless window. **NOTE:** On macOS corner is not ellipse but circle rounded by the
|
|
962
962
|
* average of _height_ and _width_.
|
|
963
963
|
*/
|
|
964
|
-
export
|
|
964
|
+
export type CornerRounding = {
|
|
965
965
|
/**
|
|
966
966
|
* @defaultValue 0
|
|
967
967
|
*
|
|
@@ -978,7 +978,7 @@ export declare type CornerRounding = {
|
|
|
978
978
|
/**
|
|
979
979
|
* Options for downloading a preload script.
|
|
980
980
|
*/
|
|
981
|
-
export
|
|
981
|
+
export type DownloadPreloadOption = {
|
|
982
982
|
/**
|
|
983
983
|
* URL from which to download the preload script.
|
|
984
984
|
*/
|
|
@@ -987,7 +987,7 @@ export declare type DownloadPreloadOption = {
|
|
|
987
987
|
/**
|
|
988
988
|
* Metadata returned from a preload script download request.
|
|
989
989
|
*/
|
|
990
|
-
export
|
|
990
|
+
export type DownloadPreloadInfo = {
|
|
991
991
|
/**
|
|
992
992
|
* Whether the download was successful.
|
|
993
993
|
*/
|
|
@@ -1001,7 +1001,7 @@ export declare type DownloadPreloadInfo = {
|
|
|
1001
1001
|
*/
|
|
1002
1002
|
error: string;
|
|
1003
1003
|
};
|
|
1004
|
-
export
|
|
1004
|
+
export type RGB = {
|
|
1005
1005
|
red: number;
|
|
1006
1006
|
blue: number;
|
|
1007
1007
|
green: number;
|
|
@@ -1010,7 +1010,7 @@ export declare type RGB = {
|
|
|
1010
1010
|
* @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
|
|
1011
1011
|
* Configure the context menu when right-clicking on a window.
|
|
1012
1012
|
*/
|
|
1013
|
-
export
|
|
1013
|
+
export type ContextMenuSettings = {
|
|
1014
1014
|
/**
|
|
1015
1015
|
* Should the context menu display on right click.
|
|
1016
1016
|
*/
|
|
@@ -1027,7 +1027,7 @@ export declare type ContextMenuSettings = {
|
|
|
1027
1027
|
/**
|
|
1028
1028
|
* A hotkey binding.
|
|
1029
1029
|
*/
|
|
1030
|
-
export
|
|
1030
|
+
export type Hotkey = {
|
|
1031
1031
|
/**
|
|
1032
1032
|
* The key combination of the hotkey, i.e. "Ctrl+T".
|
|
1033
1033
|
*/
|
|
@@ -1039,13 +1039,13 @@ export declare type Hotkey = {
|
|
|
1039
1039
|
*/
|
|
1040
1040
|
preventDefault?: boolean;
|
|
1041
1041
|
};
|
|
1042
|
-
export
|
|
1042
|
+
export type ShortcutOverride = Hotkey & {
|
|
1043
1043
|
command: string;
|
|
1044
1044
|
};
|
|
1045
1045
|
/**
|
|
1046
1046
|
* A script that is run before page load.
|
|
1047
1047
|
*/
|
|
1048
|
-
export
|
|
1048
|
+
export type PreloadScript = {
|
|
1049
1049
|
/**
|
|
1050
1050
|
* @defaultValue false
|
|
1051
1051
|
*
|
|
@@ -1061,7 +1061,7 @@ export declare type PreloadScript = {
|
|
|
1061
1061
|
*/
|
|
1062
1062
|
url: string;
|
|
1063
1063
|
};
|
|
1064
|
-
export
|
|
1064
|
+
export type AutoResizeOptions = {
|
|
1065
1065
|
/**
|
|
1066
1066
|
* If true, the view's width will grow and shrink together with the window. false
|
|
1067
1067
|
* by default.
|
|
@@ -1083,7 +1083,7 @@ export declare type AutoResizeOptions = {
|
|
|
1083
1083
|
*/
|
|
1084
1084
|
vertical?: boolean;
|
|
1085
1085
|
};
|
|
1086
|
-
export
|
|
1086
|
+
export type InteropConfig = {
|
|
1087
1087
|
/**
|
|
1088
1088
|
* Context Group for the client. (green, yellow, red, etc.).
|
|
1089
1089
|
*/
|
|
@@ -1093,7 +1093,7 @@ export declare type InteropConfig = {
|
|
|
1093
1093
|
*/
|
|
1094
1094
|
providerId?: string;
|
|
1095
1095
|
};
|
|
1096
|
-
export
|
|
1096
|
+
export type ViewInfo = {
|
|
1097
1097
|
canNavigateBack: boolean;
|
|
1098
1098
|
canNavigateForward: boolean;
|
|
1099
1099
|
processAffinity: string;
|
|
@@ -1104,19 +1104,19 @@ export declare type ViewInfo = {
|
|
|
1104
1104
|
/**
|
|
1105
1105
|
* View options that can be updated after creation.
|
|
1106
1106
|
*/
|
|
1107
|
-
export
|
|
1107
|
+
export type UpdatableViewOptions = Partial<MutableViewOptions>;
|
|
1108
1108
|
/**
|
|
1109
1109
|
* The options object required by {@link View.create View.create}.
|
|
1110
1110
|
*
|
|
1111
1111
|
* Note that `name` and `target` are the only required properties — albeit the `url` property is usually provided as well
|
|
1112
1112
|
* (defaults to `"about:blank"` when omitted).
|
|
1113
1113
|
*/
|
|
1114
|
-
export
|
|
1114
|
+
export type ViewCreationOptions = Partial<ViewOptions> & {
|
|
1115
1115
|
name: string;
|
|
1116
1116
|
url: string;
|
|
1117
1117
|
target: Identity;
|
|
1118
1118
|
};
|
|
1119
|
-
export
|
|
1119
|
+
export type MutableViewOptions = {
|
|
1120
1120
|
autoResize: AutoResizeOptions;
|
|
1121
1121
|
/**
|
|
1122
1122
|
* @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
|
|
@@ -1195,11 +1195,11 @@ export declare type MutableViewOptions = {
|
|
|
1195
1195
|
/**
|
|
1196
1196
|
* User-facing options for a view.
|
|
1197
1197
|
*/
|
|
1198
|
-
export
|
|
1198
|
+
export type ViewOptions = ConstViewOptions & MutableViewOptions;
|
|
1199
1199
|
/**
|
|
1200
1200
|
* View options that cannot be updated after creation.
|
|
1201
1201
|
*/
|
|
1202
|
-
export
|
|
1202
|
+
export type ConstViewOptions = {
|
|
1203
1203
|
/**
|
|
1204
1204
|
* The name of the view.
|
|
1205
1205
|
*/
|
|
@@ -1257,13 +1257,13 @@ export declare type ConstViewOptions = {
|
|
|
1257
1257
|
accelerator?: Partial<Accelerator>;
|
|
1258
1258
|
autoplayPolicy: AutoplayPolicyOptions;
|
|
1259
1259
|
};
|
|
1260
|
-
export
|
|
1260
|
+
export type ViewState = ViewCreationOptions & {
|
|
1261
1261
|
backgroundThrottling: boolean;
|
|
1262
1262
|
componentName: 'view';
|
|
1263
1263
|
initialUrl: string;
|
|
1264
1264
|
minWidth?: number;
|
|
1265
1265
|
};
|
|
1266
|
-
export
|
|
1266
|
+
export type Certificate = {
|
|
1267
1267
|
data: string;
|
|
1268
1268
|
fingerprint: string;
|
|
1269
1269
|
issuer: CertificatePrincipal;
|
|
@@ -1275,7 +1275,7 @@ export declare type Certificate = {
|
|
|
1275
1275
|
validExpiry: number;
|
|
1276
1276
|
validStart: number;
|
|
1277
1277
|
};
|
|
1278
|
-
|
|
1278
|
+
type CertificatePrincipal = {
|
|
1279
1279
|
commonName: string;
|
|
1280
1280
|
country: string;
|
|
1281
1281
|
locality: string;
|
|
@@ -1283,7 +1283,7 @@ declare type CertificatePrincipal = {
|
|
|
1283
1283
|
organizationUnits: string[];
|
|
1284
1284
|
state: string;
|
|
1285
1285
|
};
|
|
1286
|
-
export
|
|
1286
|
+
export type HostContextChangedPayload = {
|
|
1287
1287
|
/**
|
|
1288
1288
|
* The new context object
|
|
1289
1289
|
*/
|
|
@@ -1293,7 +1293,7 @@ export declare type HostContextChangedPayload = {
|
|
|
1293
1293
|
*/
|
|
1294
1294
|
reason: HostContextChangedReasons;
|
|
1295
1295
|
};
|
|
1296
|
-
export
|
|
1296
|
+
export type ApplySnapshotOptions = {
|
|
1297
1297
|
/**
|
|
1298
1298
|
* @defaultValue false
|
|
1299
1299
|
*
|
|
@@ -1320,7 +1320,7 @@ export declare type ApplySnapshotOptions = {
|
|
|
1320
1320
|
/**
|
|
1321
1321
|
* Payload sent to Platform Provider when {@link Platform#applySnapshot Platform.applySnapshot} is called.
|
|
1322
1322
|
*/
|
|
1323
|
-
export
|
|
1323
|
+
export type ApplySnapshotPayload = {
|
|
1324
1324
|
/**
|
|
1325
1325
|
* TThe snapshot to be applied.
|
|
1326
1326
|
*/
|
|
@@ -1330,7 +1330,7 @@ export declare type ApplySnapshotPayload = {
|
|
|
1330
1330
|
*/
|
|
1331
1331
|
options?: ApplySnapshotOptions;
|
|
1332
1332
|
};
|
|
1333
|
-
export
|
|
1333
|
+
export type CreateViewPayload = {
|
|
1334
1334
|
/**
|
|
1335
1335
|
* Options for the view to be added.
|
|
1336
1336
|
*/
|
|
@@ -1341,32 +1341,32 @@ export declare type CreateViewPayload = {
|
|
|
1341
1341
|
target: Identity;
|
|
1342
1342
|
targetView?: Identity;
|
|
1343
1343
|
};
|
|
1344
|
-
export
|
|
1344
|
+
export type ReplaceViewPayload = {
|
|
1345
1345
|
opts: {
|
|
1346
1346
|
viewToReplace: Identity;
|
|
1347
1347
|
newView: Partial<ViewOptions>;
|
|
1348
1348
|
};
|
|
1349
1349
|
target: Identity;
|
|
1350
1350
|
};
|
|
1351
|
-
export
|
|
1351
|
+
export type CloseViewPayload = {
|
|
1352
1352
|
/**
|
|
1353
1353
|
*View to be closed.
|
|
1354
1354
|
*/
|
|
1355
1355
|
view: Identity;
|
|
1356
1356
|
};
|
|
1357
|
-
export
|
|
1357
|
+
export type FetchManifestPayload = {
|
|
1358
1358
|
/**
|
|
1359
1359
|
* The URL of the manifest to fetch.
|
|
1360
1360
|
*/
|
|
1361
1361
|
manifestUrl: string;
|
|
1362
1362
|
};
|
|
1363
|
-
export
|
|
1363
|
+
export type ReplaceLayoutOpts = {
|
|
1364
1364
|
/**
|
|
1365
1365
|
* Layout config to be applied.
|
|
1366
1366
|
*/
|
|
1367
1367
|
layout: LayoutOptions;
|
|
1368
1368
|
};
|
|
1369
|
-
export
|
|
1369
|
+
export type ReplaceLayoutPayload = {
|
|
1370
1370
|
/**
|
|
1371
1371
|
* Object containing the layout to be applied.
|
|
1372
1372
|
*/
|
|
@@ -1376,7 +1376,7 @@ export declare type ReplaceLayoutPayload = {
|
|
|
1376
1376
|
*/
|
|
1377
1377
|
target: Identity;
|
|
1378
1378
|
};
|
|
1379
|
-
export
|
|
1379
|
+
export type SetWindowContextPayload = {
|
|
1380
1380
|
/**
|
|
1381
1381
|
* The requested context update.
|
|
1382
1382
|
*/
|
|
@@ -1390,10 +1390,10 @@ export declare type SetWindowContextPayload = {
|
|
|
1390
1390
|
*/
|
|
1391
1391
|
target: Identity;
|
|
1392
1392
|
};
|
|
1393
|
-
export
|
|
1393
|
+
export type LaunchIntoPlatformPayload = {
|
|
1394
1394
|
manifest: any;
|
|
1395
1395
|
};
|
|
1396
|
-
export
|
|
1396
|
+
export type GetWindowContextPayload = {
|
|
1397
1397
|
/**
|
|
1398
1398
|
* Entity type of the target of the context update ('view' or 'window').
|
|
1399
1399
|
*/
|
|
@@ -1403,14 +1403,14 @@ export declare type GetWindowContextPayload = {
|
|
|
1403
1403
|
*/
|
|
1404
1404
|
target: Identity;
|
|
1405
1405
|
};
|
|
1406
|
-
export
|
|
1406
|
+
export type ApplicationPermissions = {
|
|
1407
1407
|
setFileDownloadLocation: boolean;
|
|
1408
1408
|
};
|
|
1409
|
-
export
|
|
1409
|
+
export type LaunchExternalProcessRule = {
|
|
1410
1410
|
behavior: 'allow' | 'block';
|
|
1411
1411
|
match: string[];
|
|
1412
1412
|
};
|
|
1413
|
-
export
|
|
1413
|
+
export type SystemPermissions = {
|
|
1414
1414
|
getAllExternalWindows: boolean;
|
|
1415
1415
|
launchExternalProcess: boolean | {
|
|
1416
1416
|
enabled: boolean;
|
|
@@ -1436,13 +1436,13 @@ export declare type SystemPermissions = {
|
|
|
1436
1436
|
protocols: string[];
|
|
1437
1437
|
};
|
|
1438
1438
|
};
|
|
1439
|
-
export
|
|
1440
|
-
export
|
|
1439
|
+
export type WebPermission = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write';
|
|
1440
|
+
export type Permissions = {
|
|
1441
1441
|
Application?: Partial<ApplicationPermissions>;
|
|
1442
1442
|
System?: Partial<SystemPermissions>;
|
|
1443
1443
|
webAPIs?: WebPermission[];
|
|
1444
1444
|
};
|
|
1445
|
-
export
|
|
1445
|
+
export type PlatformWindowCreationOptions = Partial<WindowCreationOptions> & {
|
|
1446
1446
|
updateStateIfExists?: boolean;
|
|
1447
1447
|
reason?: WindowCreationReason;
|
|
1448
1448
|
};
|
|
@@ -1452,7 +1452,7 @@ export declare type PlatformWindowCreationOptions = Partial<WindowCreationOption
|
|
|
1452
1452
|
* used by default in any window that is created in the current platform's scope.
|
|
1453
1453
|
* Individual window options will override these defaults.
|
|
1454
1454
|
*/
|
|
1455
|
-
export
|
|
1455
|
+
export type PlatformWindowOptions = WindowCreationOptions & {
|
|
1456
1456
|
/**
|
|
1457
1457
|
* Specify a path of a custom CSS file to be injected to all of the platform's windows.
|
|
1458
1458
|
* _note_: this option is only applied to windows that use the Default OpenFin Window.
|
|
@@ -1460,7 +1460,7 @@ export declare type PlatformWindowOptions = WindowCreationOptions & {
|
|
|
1460
1460
|
*/
|
|
1461
1461
|
stylesheetUrl: string;
|
|
1462
1462
|
};
|
|
1463
|
-
export
|
|
1463
|
+
export type PlatformViewCreationOptions = Partial<ViewOptions> & {
|
|
1464
1464
|
url: string;
|
|
1465
1465
|
target: Identity;
|
|
1466
1466
|
};
|
|
@@ -1470,12 +1470,12 @@ export declare type PlatformViewCreationOptions = Partial<ViewOptions> & {
|
|
|
1470
1470
|
* `same`: views in the same domain will have the same process affinity.
|
|
1471
1471
|
* `different`: views in the same domain will have different process affinities.
|
|
1472
1472
|
*/
|
|
1473
|
-
export
|
|
1473
|
+
export type ProcessAffinityStrategy = 'same' | 'different';
|
|
1474
1474
|
/**
|
|
1475
1475
|
* The options object required by {@link Platform#start Platform.start}
|
|
1476
1476
|
* Any {@link ApplicationOptions Application option} is also a valid platform option
|
|
1477
1477
|
*/
|
|
1478
|
-
export
|
|
1478
|
+
export type PlatformOptions = ApplicationCreationOptions & {
|
|
1479
1479
|
/**
|
|
1480
1480
|
* Default window options apply to all platform windows.
|
|
1481
1481
|
*/
|
|
@@ -1492,7 +1492,7 @@ export declare type PlatformOptions = ApplicationCreationOptions & {
|
|
|
1492
1492
|
providerUrl?: string;
|
|
1493
1493
|
permissions?: Partial<Permissions>;
|
|
1494
1494
|
};
|
|
1495
|
-
export
|
|
1495
|
+
export type Manifest = {
|
|
1496
1496
|
appAssets?: {
|
|
1497
1497
|
alias: string;
|
|
1498
1498
|
args?: string;
|
|
@@ -1548,13 +1548,13 @@ export declare type Manifest = {
|
|
|
1548
1548
|
};
|
|
1549
1549
|
interopBrokerConfiguration: InteropBrokerOptions;
|
|
1550
1550
|
};
|
|
1551
|
-
export
|
|
1551
|
+
export type LayoutContent = Array<LayoutItemConfig | LayoutRow | LayoutColumn | LayoutComponent>;
|
|
1552
1552
|
/**
|
|
1553
1553
|
* Represents the arrangement of Views within a Platform window's Layout. We do not recommend trying
|
|
1554
1554
|
* to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot} or our
|
|
1555
1555
|
* {@link https://openfin.github.io/golden-prototype/config-gen Layout Config Generation Tool }..
|
|
1556
1556
|
*/
|
|
1557
|
-
export
|
|
1557
|
+
export type LayoutItemConfig = {
|
|
1558
1558
|
/**
|
|
1559
1559
|
* The type of the item. Possible values are 'row', 'column', 'stack', and 'component'.
|
|
1560
1560
|
*/
|
|
@@ -1579,7 +1579,7 @@ export interface LayoutComponent extends LayoutItemConfig {
|
|
|
1579
1579
|
componentName: 'view';
|
|
1580
1580
|
componentState?: Partial<ViewCreationOptions>;
|
|
1581
1581
|
}
|
|
1582
|
-
export
|
|
1582
|
+
export type LayoutOptions = {
|
|
1583
1583
|
/**
|
|
1584
1584
|
* Represents a potential ways to customize behavior of your Layout
|
|
1585
1585
|
*/
|
|
@@ -1656,18 +1656,18 @@ export declare type LayoutOptions = {
|
|
|
1656
1656
|
headerHeight?: number;
|
|
1657
1657
|
};
|
|
1658
1658
|
};
|
|
1659
|
-
export
|
|
1660
|
-
export
|
|
1661
|
-
export
|
|
1662
|
-
export
|
|
1663
|
-
export
|
|
1659
|
+
export type OverrideCallback<T extends any = PlatformProvider, U extends T = T> = (arg: Constructor<T>) => U | Promise<U>;
|
|
1660
|
+
export type Constructor<T = {}> = new () => T;
|
|
1661
|
+
export type HostContextChangedReasons = 'updated' | 'reparented';
|
|
1662
|
+
export type WindowCreationReason = 'tearout' | 'create-view-without-target' | 'api-call' | 'app-creation' | 'restore' | 'apply-snapshot';
|
|
1663
|
+
export type InitPlatformOptions = {
|
|
1664
1664
|
overrideCallback?: OverrideCallback<PlatformProvider>;
|
|
1665
1665
|
/**
|
|
1666
1666
|
* A callback function that can be used to extend or replace default Provider behavior.
|
|
1667
1667
|
*/
|
|
1668
1668
|
interopOverride?: OverrideCallback<InteropBroker>;
|
|
1669
1669
|
};
|
|
1670
|
-
export
|
|
1670
|
+
export type ProcessDetails = {
|
|
1671
1671
|
/**
|
|
1672
1672
|
* The percentage of total CPU usage.
|
|
1673
1673
|
*/
|
|
@@ -1711,7 +1711,7 @@ export declare type ProcessDetails = {
|
|
|
1711
1711
|
*/
|
|
1712
1712
|
pid: number;
|
|
1713
1713
|
};
|
|
1714
|
-
export
|
|
1714
|
+
export type FrameProcessDetails = ProcessDetails & {
|
|
1715
1715
|
/**
|
|
1716
1716
|
* Current URL associated with the process.
|
|
1717
1717
|
*/
|
|
@@ -1721,12 +1721,12 @@ export declare type FrameProcessDetails = ProcessDetails & {
|
|
|
1721
1721
|
*/
|
|
1722
1722
|
entityType: string;
|
|
1723
1723
|
};
|
|
1724
|
-
export
|
|
1724
|
+
export type EntityProcessDetails = FrameProcessDetails & {
|
|
1725
1725
|
name: string;
|
|
1726
1726
|
uuid: string;
|
|
1727
1727
|
iframes: FrameProcessDetails[];
|
|
1728
1728
|
};
|
|
1729
|
-
export
|
|
1729
|
+
export type AppProcessInfo = {
|
|
1730
1730
|
/**
|
|
1731
1731
|
* The uuid of the application.
|
|
1732
1732
|
*/
|
|
@@ -1736,15 +1736,15 @@ export declare type AppProcessInfo = {
|
|
|
1736
1736
|
*/
|
|
1737
1737
|
entities: EntityProcessDetails[];
|
|
1738
1738
|
};
|
|
1739
|
-
export
|
|
1739
|
+
export type NonAppProcessDetails = ProcessDetails & {
|
|
1740
1740
|
name: string;
|
|
1741
1741
|
};
|
|
1742
|
-
export
|
|
1742
|
+
export type SystemProcessInfo = {
|
|
1743
1743
|
apps: AppProcessInfo[];
|
|
1744
1744
|
browserProcess: NonAppProcessDetails;
|
|
1745
1745
|
nonApps: NonAppProcessDetails[];
|
|
1746
1746
|
};
|
|
1747
|
-
export
|
|
1747
|
+
export type ClearCacheOption = {
|
|
1748
1748
|
/**
|
|
1749
1749
|
* html5 application cache
|
|
1750
1750
|
*/
|
|
@@ -1762,29 +1762,29 @@ export declare type ClearCacheOption = {
|
|
|
1762
1762
|
*/
|
|
1763
1763
|
localStorage?: boolean;
|
|
1764
1764
|
};
|
|
1765
|
-
export
|
|
1765
|
+
export type CookieInfo = {
|
|
1766
1766
|
name: string;
|
|
1767
1767
|
domain: string;
|
|
1768
1768
|
path: string;
|
|
1769
1769
|
};
|
|
1770
|
-
export
|
|
1770
|
+
export type CookieOption = {
|
|
1771
1771
|
name: string;
|
|
1772
1772
|
};
|
|
1773
|
-
export
|
|
1773
|
+
export type CrashReporterOptions = {
|
|
1774
1774
|
/**
|
|
1775
1775
|
* In diagnostics mode the crash reporter will send diagnostic logs to
|
|
1776
1776
|
* the OpenFin reporting service on runtime shutdown
|
|
1777
1777
|
*/
|
|
1778
1778
|
diagnosticsMode: boolean;
|
|
1779
1779
|
};
|
|
1780
|
-
export
|
|
1780
|
+
export type CrashReporterState = CrashReporterOptions & {
|
|
1781
1781
|
/**
|
|
1782
1782
|
* Whether the crash reporter is running
|
|
1783
1783
|
*/
|
|
1784
1784
|
isRunning: boolean;
|
|
1785
1785
|
diagnosticMode: boolean;
|
|
1786
1786
|
};
|
|
1787
|
-
export
|
|
1787
|
+
export type Time = {
|
|
1788
1788
|
/**
|
|
1789
1789
|
* The number of milliseconds the CPU has spent in user mode.
|
|
1790
1790
|
*/
|
|
@@ -1806,7 +1806,7 @@ export declare type Time = {
|
|
|
1806
1806
|
*/
|
|
1807
1807
|
irq: number;
|
|
1808
1808
|
};
|
|
1809
|
-
export
|
|
1809
|
+
export type CpuInfo = {
|
|
1810
1810
|
/**
|
|
1811
1811
|
* The model of the cpu
|
|
1812
1812
|
*/
|
|
@@ -1820,10 +1820,10 @@ export declare type CpuInfo = {
|
|
|
1820
1820
|
*/
|
|
1821
1821
|
times: Time;
|
|
1822
1822
|
};
|
|
1823
|
-
export
|
|
1823
|
+
export type GpuInfo = {
|
|
1824
1824
|
name: string;
|
|
1825
1825
|
};
|
|
1826
|
-
export
|
|
1826
|
+
export type HostSpecs = {
|
|
1827
1827
|
/**
|
|
1828
1828
|
* True if Aero Glass theme is supported on Windows platforms
|
|
1829
1829
|
*/
|
|
@@ -1853,7 +1853,7 @@ export declare type HostSpecs = {
|
|
|
1853
1853
|
*/
|
|
1854
1854
|
screenSaver?: boolean;
|
|
1855
1855
|
};
|
|
1856
|
-
export
|
|
1856
|
+
export type PrinterInfo = {
|
|
1857
1857
|
name: string;
|
|
1858
1858
|
description: string;
|
|
1859
1859
|
status: number;
|
|
@@ -1862,7 +1862,7 @@ export declare type PrinterInfo = {
|
|
|
1862
1862
|
/**
|
|
1863
1863
|
* DPI (dots per inch) configuration for printing.
|
|
1864
1864
|
*/
|
|
1865
|
-
export
|
|
1865
|
+
export type Dpi = {
|
|
1866
1866
|
/**
|
|
1867
1867
|
* DPI (dots per inch) in the horizontal direction.
|
|
1868
1868
|
*/
|
|
@@ -1875,7 +1875,7 @@ export declare type Dpi = {
|
|
|
1875
1875
|
/**
|
|
1876
1876
|
* Margins configuration for printing.
|
|
1877
1877
|
*/
|
|
1878
|
-
export
|
|
1878
|
+
export type Margins = {
|
|
1879
1879
|
marginType?: 'default' | 'none' | 'printableArea' | 'custom';
|
|
1880
1880
|
/**
|
|
1881
1881
|
* The top margin of the printed webpage, in pixels.
|
|
@@ -1897,7 +1897,7 @@ export declare type Margins = {
|
|
|
1897
1897
|
/**
|
|
1898
1898
|
* Options for printing a webpage in OpenFin.
|
|
1899
1899
|
*/
|
|
1900
|
-
export
|
|
1900
|
+
export type PrintOptions = {
|
|
1901
1901
|
/**
|
|
1902
1902
|
* Disables prompting the user for print settings.
|
|
1903
1903
|
*/
|
|
@@ -1954,7 +1954,7 @@ export declare type PrintOptions = {
|
|
|
1954
1954
|
/**
|
|
1955
1955
|
* A request to write data to the clipboard.
|
|
1956
1956
|
*/
|
|
1957
|
-
export
|
|
1957
|
+
export type WriteRequestType = {
|
|
1958
1958
|
/**
|
|
1959
1959
|
* Data to write to the clipboard.
|
|
1960
1960
|
*/
|
|
@@ -1964,7 +1964,7 @@ export declare type WriteRequestType = {
|
|
|
1964
1964
|
*/
|
|
1965
1965
|
type?: string;
|
|
1966
1966
|
};
|
|
1967
|
-
export
|
|
1967
|
+
export type WriteAnyRequestType = {
|
|
1968
1968
|
data: {
|
|
1969
1969
|
text?: string;
|
|
1970
1970
|
html?: string;
|
|
@@ -1972,30 +1972,30 @@ export declare type WriteAnyRequestType = {
|
|
|
1972
1972
|
};
|
|
1973
1973
|
type?: string;
|
|
1974
1974
|
};
|
|
1975
|
-
export
|
|
1975
|
+
export type SubscriptionOptions = {
|
|
1976
1976
|
/**
|
|
1977
1977
|
* The event timestamp.
|
|
1978
1978
|
*/
|
|
1979
1979
|
timestamp?: number;
|
|
1980
1980
|
};
|
|
1981
|
-
export
|
|
1981
|
+
export type SharedWorkerInfo = {
|
|
1982
1982
|
id: string;
|
|
1983
1983
|
url: string;
|
|
1984
1984
|
};
|
|
1985
|
-
export
|
|
1985
|
+
export type ServiceIdentifier = {
|
|
1986
1986
|
/**
|
|
1987
1987
|
* The name of the service.
|
|
1988
1988
|
*/
|
|
1989
1989
|
name: string;
|
|
1990
1990
|
};
|
|
1991
|
-
export
|
|
1991
|
+
export type ServiceConfiguration = {
|
|
1992
1992
|
config: object;
|
|
1993
1993
|
/**
|
|
1994
1994
|
* The name of the service.
|
|
1995
1995
|
*/
|
|
1996
1996
|
name: string;
|
|
1997
1997
|
};
|
|
1998
|
-
export
|
|
1998
|
+
export type RVMInfo = {
|
|
1999
1999
|
/**
|
|
2000
2000
|
* The name of action: "get-rvm-info".
|
|
2001
2001
|
*/
|
|
@@ -2021,15 +2021,15 @@ export declare type RVMInfo = {
|
|
|
2021
2021
|
*/
|
|
2022
2022
|
'working-dir': string;
|
|
2023
2023
|
};
|
|
2024
|
-
export
|
|
2024
|
+
export type AppVersionProgress = {
|
|
2025
2025
|
manifest: string | null;
|
|
2026
2026
|
srcManifest: string;
|
|
2027
2027
|
};
|
|
2028
|
-
export
|
|
2028
|
+
export type AppVersionError = {
|
|
2029
2029
|
error: string;
|
|
2030
2030
|
srcManifest: string;
|
|
2031
2031
|
};
|
|
2032
|
-
export
|
|
2032
|
+
export type AppVersionRuntimeInfo = {
|
|
2033
2033
|
version: string | null;
|
|
2034
2034
|
exists: boolean | null;
|
|
2035
2035
|
writeAccess: boolean | null;
|
|
@@ -2037,8 +2037,8 @@ export declare type AppVersionRuntimeInfo = {
|
|
|
2037
2037
|
healthCheck: boolean | null;
|
|
2038
2038
|
error: string | null;
|
|
2039
2039
|
};
|
|
2040
|
-
export
|
|
2041
|
-
export
|
|
2040
|
+
export type LaunchEmitter = TypedEventEmitter<AppVersionEvent>;
|
|
2041
|
+
export type RvmLaunchOptions = {
|
|
2042
2042
|
/**
|
|
2043
2043
|
* True if no UI when launching
|
|
2044
2044
|
*/
|
|
@@ -2053,7 +2053,7 @@ export declare type RvmLaunchOptions = {
|
|
|
2053
2053
|
*/
|
|
2054
2054
|
subscribe?: (launch: LaunchEmitter) => void;
|
|
2055
2055
|
};
|
|
2056
|
-
export
|
|
2056
|
+
export type ShortCutConfig = {
|
|
2057
2057
|
/**
|
|
2058
2058
|
* True if application has a shortcut on the desktop.
|
|
2059
2059
|
*/
|
|
@@ -2067,7 +2067,7 @@ export declare type ShortCutConfig = {
|
|
|
2067
2067
|
*/
|
|
2068
2068
|
systemStartup?: boolean;
|
|
2069
2069
|
};
|
|
2070
|
-
export
|
|
2070
|
+
export type TerminateExternalRequestType = {
|
|
2071
2071
|
/**
|
|
2072
2072
|
* The uuid of the running application.
|
|
2073
2073
|
*/
|
|
@@ -2081,7 +2081,7 @@ export declare type TerminateExternalRequestType = {
|
|
|
2081
2081
|
*/
|
|
2082
2082
|
killTree: boolean;
|
|
2083
2083
|
};
|
|
2084
|
-
export
|
|
2084
|
+
export type TrayInfo = {
|
|
2085
2085
|
/**
|
|
2086
2086
|
* The bound of tray icon in virtual screen pixels.
|
|
2087
2087
|
*/
|
|
@@ -2099,12 +2099,12 @@ export declare type TrayInfo = {
|
|
|
2099
2099
|
*/
|
|
2100
2100
|
y: number;
|
|
2101
2101
|
};
|
|
2102
|
-
export
|
|
2102
|
+
export type Transition = {
|
|
2103
2103
|
opacity?: Opacity;
|
|
2104
2104
|
position?: Position;
|
|
2105
2105
|
size?: Size;
|
|
2106
2106
|
};
|
|
2107
|
-
export
|
|
2107
|
+
export type Size = TransitionBase & {
|
|
2108
2108
|
/**
|
|
2109
2109
|
* Optional if height is present. Defaults to the window's current width.
|
|
2110
2110
|
*/
|
|
@@ -2114,7 +2114,7 @@ export declare type Size = TransitionBase & {
|
|
|
2114
2114
|
*/
|
|
2115
2115
|
height: number;
|
|
2116
2116
|
};
|
|
2117
|
-
export
|
|
2117
|
+
export type Opacity = TransitionBase & {
|
|
2118
2118
|
/**
|
|
2119
2119
|
* The opacity from 0.0 (transparent) to 1.0 (normal).
|
|
2120
2120
|
*/
|
|
@@ -2123,7 +2123,7 @@ export declare type Opacity = TransitionBase & {
|
|
|
2123
2123
|
/**
|
|
2124
2124
|
* Base configuration options needed for all types of transitions.
|
|
2125
2125
|
*/
|
|
2126
|
-
export
|
|
2126
|
+
export type TransitionBase = {
|
|
2127
2127
|
/**
|
|
2128
2128
|
* The total time in milliseconds this transition should take.
|
|
2129
2129
|
*/
|
|
@@ -2135,7 +2135,7 @@ export declare type TransitionBase = {
|
|
|
2135
2135
|
*/
|
|
2136
2136
|
relative?: boolean;
|
|
2137
2137
|
};
|
|
2138
|
-
export
|
|
2138
|
+
export type Position = TransitionBase & {
|
|
2139
2139
|
/**
|
|
2140
2140
|
* Defaults to the window's current left position in virtual screen coordinates.
|
|
2141
2141
|
*/
|
|
@@ -2145,11 +2145,11 @@ export declare type Position = TransitionBase & {
|
|
|
2145
2145
|
*/
|
|
2146
2146
|
top: number;
|
|
2147
2147
|
};
|
|
2148
|
-
export
|
|
2148
|
+
export type AnchorType = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
|
|
2149
2149
|
/**
|
|
2150
2150
|
* Configuration for transition between windows.
|
|
2151
2151
|
*/
|
|
2152
|
-
export
|
|
2152
|
+
export type TransitionOptions = {
|
|
2153
2153
|
/**
|
|
2154
2154
|
* Interrupts the current animation (otherwise, the animation is added to the end of the queue).
|
|
2155
2155
|
*/
|
|
@@ -2162,11 +2162,11 @@ export declare type TransitionOptions = {
|
|
|
2162
2162
|
relative?: boolean;
|
|
2163
2163
|
tween?: tween;
|
|
2164
2164
|
};
|
|
2165
|
-
export
|
|
2165
|
+
export type tween = 'linear' | 'ease-in' | 'ease-out' | 'ease-in-out' | 'ease-in-quad' | 'ease-out-quad' | 'ease-in-out-quad' | 'ease-in-cubic' | 'ease-out-cubic' | 'ease-in-out-cubic' | 'ease-out-bounce' | 'ease-in-back' | 'ease-out-back' | 'ease-in-out-back' | 'ease-in-elastic' | 'ease-out-elastic' | 'ease-in-out-elastic';
|
|
2166
2166
|
/**
|
|
2167
2167
|
* Configuration for find-in-page requests.
|
|
2168
2168
|
*/
|
|
2169
|
-
export
|
|
2169
|
+
export type FindInPageOptions = {
|
|
2170
2170
|
/**
|
|
2171
2171
|
* @defaultValue true
|
|
2172
2172
|
*
|
|
@@ -2199,16 +2199,16 @@ export declare type FindInPageOptions = {
|
|
|
2199
2199
|
*/
|
|
2200
2200
|
medialCapitalAsWordStart?: boolean;
|
|
2201
2201
|
};
|
|
2202
|
-
export
|
|
2202
|
+
export type FrameInfo = {
|
|
2203
2203
|
name: string;
|
|
2204
2204
|
uuid: string;
|
|
2205
2205
|
entityType: EntityType;
|
|
2206
2206
|
parent: Identity;
|
|
2207
2207
|
};
|
|
2208
|
-
export
|
|
2208
|
+
export type ExternalApplicationInfo = {
|
|
2209
2209
|
parent: Identity;
|
|
2210
2210
|
};
|
|
2211
|
-
export
|
|
2211
|
+
export type ExternalConnection = {
|
|
2212
2212
|
/**
|
|
2213
2213
|
* The token to broker an external connection.
|
|
2214
2214
|
*/
|
|
@@ -2218,7 +2218,7 @@ export declare type ExternalConnection = {
|
|
|
2218
2218
|
*/
|
|
2219
2219
|
uuid: string;
|
|
2220
2220
|
};
|
|
2221
|
-
export
|
|
2221
|
+
export type ExternalProcessRequestType = {
|
|
2222
2222
|
/**
|
|
2223
2223
|
* The file path to where the running application resides.
|
|
2224
2224
|
*/
|
|
@@ -2241,26 +2241,26 @@ export declare type ExternalProcessRequestType = {
|
|
|
2241
2241
|
*/
|
|
2242
2242
|
cwd?: string;
|
|
2243
2243
|
};
|
|
2244
|
-
export
|
|
2244
|
+
export type CertificationInfo = {
|
|
2245
2245
|
serial?: string;
|
|
2246
2246
|
subject?: string;
|
|
2247
2247
|
publickey?: string;
|
|
2248
2248
|
thumbprint?: string;
|
|
2249
2249
|
trusted?: boolean;
|
|
2250
2250
|
};
|
|
2251
|
-
export
|
|
2251
|
+
export type ExitCode = {
|
|
2252
2252
|
topic: string;
|
|
2253
2253
|
uuid: string;
|
|
2254
2254
|
exitCode: number;
|
|
2255
2255
|
};
|
|
2256
|
-
export
|
|
2256
|
+
export type LaunchExternalProcessListener = {
|
|
2257
2257
|
(code: ExitCode): void;
|
|
2258
2258
|
};
|
|
2259
|
-
export
|
|
2259
|
+
export type ExternalProcessInfo = {
|
|
2260
2260
|
pid: number;
|
|
2261
2261
|
listener?: LaunchExternalProcessListener;
|
|
2262
2262
|
};
|
|
2263
|
-
export
|
|
2263
|
+
export type AppAssetInfo = {
|
|
2264
2264
|
/**
|
|
2265
2265
|
* The URL to a zip file containing the package files (executables, dlls, etc…)
|
|
2266
2266
|
*/
|
|
@@ -2290,30 +2290,30 @@ export declare type AppAssetInfo = {
|
|
|
2290
2290
|
/**
|
|
2291
2291
|
* The options object required by the downloadRuntime function.
|
|
2292
2292
|
*/
|
|
2293
|
-
export
|
|
2293
|
+
export type RuntimeDownloadOptions = {
|
|
2294
2294
|
/**
|
|
2295
2295
|
* The given version to download.
|
|
2296
2296
|
*/
|
|
2297
2297
|
version: string;
|
|
2298
2298
|
};
|
|
2299
|
-
export
|
|
2299
|
+
export type AppAssetRequest = {
|
|
2300
2300
|
alias: string;
|
|
2301
2301
|
};
|
|
2302
|
-
export
|
|
2302
|
+
export type RuntimeDownloadProgress = {
|
|
2303
2303
|
/**
|
|
2304
2304
|
* @property { string } alias The name of the asset
|
|
2305
2305
|
*/
|
|
2306
2306
|
downloadedBytes: number;
|
|
2307
2307
|
totalBytes: number;
|
|
2308
2308
|
};
|
|
2309
|
-
export
|
|
2309
|
+
export type CertifiedAppInfo = {
|
|
2310
2310
|
isRunning: boolean;
|
|
2311
2311
|
isOptedIntoCertfiedApp?: boolean;
|
|
2312
2312
|
isCertified?: boolean;
|
|
2313
2313
|
isSSLCertified?: boolean;
|
|
2314
2314
|
isPresentInAppDirectory?: boolean;
|
|
2315
2315
|
};
|
|
2316
|
-
export
|
|
2316
|
+
export type JumpListCategory = {
|
|
2317
2317
|
/**
|
|
2318
2318
|
* The display title for the category.
|
|
2319
2319
|
*
|
|
@@ -2326,8 +2326,8 @@ export declare type JumpListCategory = {
|
|
|
2326
2326
|
*/
|
|
2327
2327
|
items: Array<JumpListTask | JumpListSeparator>;
|
|
2328
2328
|
};
|
|
2329
|
-
export
|
|
2330
|
-
export
|
|
2329
|
+
export type JumpListItem = JumpListTask | JumpListSeparator;
|
|
2330
|
+
export type JumpListTask = {
|
|
2331
2331
|
type: 'task';
|
|
2332
2332
|
/**
|
|
2333
2333
|
* The text to be displayed for the JumpList Item.
|
|
@@ -2354,10 +2354,10 @@ export declare type JumpListTask = {
|
|
|
2354
2354
|
*/
|
|
2355
2355
|
iconIndex?: number;
|
|
2356
2356
|
};
|
|
2357
|
-
export
|
|
2357
|
+
export type JumpListSeparator = {
|
|
2358
2358
|
type: 'separator';
|
|
2359
2359
|
};
|
|
2360
|
-
export
|
|
2360
|
+
export type ApplicationInfo = {
|
|
2361
2361
|
initialOptions: ApplicationCreationOptions;
|
|
2362
2362
|
launchMode: string;
|
|
2363
2363
|
manifest: Manifest & {
|
|
@@ -2369,7 +2369,7 @@ export declare type ApplicationInfo = {
|
|
|
2369
2369
|
version: string;
|
|
2370
2370
|
};
|
|
2371
2371
|
};
|
|
2372
|
-
export
|
|
2372
|
+
export type ManifestInfo = {
|
|
2373
2373
|
/**
|
|
2374
2374
|
* The uuid of the application.
|
|
2375
2375
|
*/
|
|
@@ -2379,20 +2379,20 @@ export declare type ManifestInfo = {
|
|
|
2379
2379
|
*/
|
|
2380
2380
|
manifestUrl: string;
|
|
2381
2381
|
};
|
|
2382
|
-
export
|
|
2382
|
+
export type ClickedMenuResult = {
|
|
2383
2383
|
result: 'clicked';
|
|
2384
2384
|
data: any;
|
|
2385
2385
|
};
|
|
2386
|
-
export
|
|
2386
|
+
export type ClosedMenuResult = {
|
|
2387
2387
|
result: 'closed';
|
|
2388
2388
|
};
|
|
2389
|
-
export
|
|
2390
|
-
export
|
|
2389
|
+
export type MenuResult = ClickedMenuResult | ClosedMenuResult;
|
|
2390
|
+
export type ShowPopupMenuOptions = {
|
|
2391
2391
|
template: MenuItemTemplate[];
|
|
2392
2392
|
x?: number;
|
|
2393
2393
|
y?: number;
|
|
2394
2394
|
};
|
|
2395
|
-
export
|
|
2395
|
+
export type MenuItemTemplate = {
|
|
2396
2396
|
/**
|
|
2397
2397
|
* Can be `normal`, `separator`, `submenu`, or `checkbox`.
|
|
2398
2398
|
* Defaults to 'normal' unless a 'submenu' key exists
|
|
@@ -2426,10 +2426,10 @@ export declare type MenuItemTemplate = {
|
|
|
2426
2426
|
*/
|
|
2427
2427
|
icon?: string;
|
|
2428
2428
|
};
|
|
2429
|
-
export
|
|
2429
|
+
export type NativeWindowIntegrationProviderAuthorization = {
|
|
2430
2430
|
authorizedUuid: string;
|
|
2431
2431
|
};
|
|
2432
|
-
export
|
|
2432
|
+
export type RuntimeInfo = {
|
|
2433
2433
|
/**
|
|
2434
2434
|
* The runtime build architecture.
|
|
2435
2435
|
*/
|
|
@@ -2458,28 +2458,28 @@ export declare type RuntimeInfo = {
|
|
|
2458
2458
|
electronVersion: string;
|
|
2459
2459
|
devtoolsPort?: number;
|
|
2460
2460
|
};
|
|
2461
|
-
export
|
|
2461
|
+
export type DefaultDomainSettings = {
|
|
2462
2462
|
rules: DefaultDomainSettingsRule[];
|
|
2463
2463
|
};
|
|
2464
|
-
export
|
|
2464
|
+
export type DefaultDomainSettingsRule = {
|
|
2465
2465
|
match: string[];
|
|
2466
2466
|
options: {
|
|
2467
2467
|
downloadSettings: FileDownloadSettings;
|
|
2468
2468
|
};
|
|
2469
2469
|
};
|
|
2470
|
-
export
|
|
2471
|
-
export
|
|
2470
|
+
export type FileDownloadBehaviorNames = 'prompt' | 'no-prompt' | 'block';
|
|
2471
|
+
export type FileDownloadSettings = {
|
|
2472
2472
|
rules: DownloadRule[];
|
|
2473
2473
|
};
|
|
2474
|
-
export
|
|
2474
|
+
export type DownloadRule = {
|
|
2475
2475
|
behavior: FileDownloadBehaviorNames;
|
|
2476
2476
|
match: string[];
|
|
2477
2477
|
};
|
|
2478
|
-
export
|
|
2478
|
+
export type ContextHandler = (context: Context) => void;
|
|
2479
2479
|
/**
|
|
2480
2480
|
* Combination of an action and a context that is passed to an application for resolution.
|
|
2481
2481
|
*/
|
|
2482
|
-
export
|
|
2482
|
+
export type Intent<MetadataType = IntentMetadata> = {
|
|
2483
2483
|
/**
|
|
2484
2484
|
* Name of the intent.
|
|
2485
2485
|
*/
|
|
@@ -2490,14 +2490,14 @@ export declare type Intent<MetadataType = IntentMetadata> = {
|
|
|
2490
2490
|
context: Context;
|
|
2491
2491
|
metadata?: MetadataType;
|
|
2492
2492
|
};
|
|
2493
|
-
export
|
|
2493
|
+
export type IntentMetadata<TargetType = any> = {
|
|
2494
2494
|
target?: TargetType;
|
|
2495
2495
|
resultType?: string;
|
|
2496
2496
|
intentResolutionResultId?: string;
|
|
2497
2497
|
};
|
|
2498
|
-
export
|
|
2499
|
-
export
|
|
2500
|
-
export
|
|
2498
|
+
export type IntentHandler = (intent: Intent) => void;
|
|
2499
|
+
export type ContentCreationBehaviorNames = 'window' | 'view' | 'block' | 'browser';
|
|
2500
|
+
export type MatchPattern = string;
|
|
2501
2501
|
/**
|
|
2502
2502
|
* A rule for creating content in OpenFin; maps a content type to the way in which
|
|
2503
2503
|
* newly-opened content of that type will be handled.
|
|
@@ -2506,7 +2506,7 @@ export declare type MatchPattern = string;
|
|
|
2506
2506
|
* @property { string[] } match List of [match patterns](https://developer.chrome.com/extensions/match_patterns).
|
|
2507
2507
|
* @property { object } options Window creation options or View creation options.
|
|
2508
2508
|
*/
|
|
2509
|
-
export
|
|
2509
|
+
export type ContentCreationRule<T = ContentCreationBehaviorNames> = {
|
|
2510
2510
|
/**
|
|
2511
2511
|
* Behavior to use when opening matched content.
|
|
2512
2512
|
*/
|
|
@@ -2524,17 +2524,17 @@ export declare type ContentCreationRule<T = ContentCreationBehaviorNames> = {
|
|
|
2524
2524
|
/**
|
|
2525
2525
|
* Configures how new content (e,g, from `window.open` or a link) is opened.
|
|
2526
2526
|
*/
|
|
2527
|
-
export
|
|
2527
|
+
export type ContentCreationOptions = {
|
|
2528
2528
|
/**
|
|
2529
2529
|
* List of rules for creation of new content.
|
|
2530
2530
|
*/
|
|
2531
2531
|
rules: ContentCreationRule[];
|
|
2532
2532
|
};
|
|
2533
|
-
export
|
|
2533
|
+
export type SnapshotProvider<T> = {
|
|
2534
2534
|
getSnapshot: () => Promise<T>;
|
|
2535
2535
|
applySnapshot: (snapshot: T) => Promise<void>;
|
|
2536
2536
|
};
|
|
2537
|
-
export
|
|
2537
|
+
export type QueryPermissionResult = {
|
|
2538
2538
|
/**
|
|
2539
2539
|
* The full name of a secured API.
|
|
2540
2540
|
*/
|
|
@@ -2549,7 +2549,7 @@ export declare type QueryPermissionResult = {
|
|
|
2549
2549
|
*/
|
|
2550
2550
|
rawValue?: unknown;
|
|
2551
2551
|
};
|
|
2552
|
-
export
|
|
2552
|
+
export type SessionContextGroup = {
|
|
2553
2553
|
id: string;
|
|
2554
2554
|
setContext: (context: Context) => Promise<void>;
|
|
2555
2555
|
getCurrentContext: (type?: string) => Promise<Context>;
|
|
@@ -2561,7 +2561,7 @@ export type { MessagingProtocols };
|
|
|
2561
2561
|
/**
|
|
2562
2562
|
* Channel provider creation options.
|
|
2563
2563
|
*/
|
|
2564
|
-
export
|
|
2564
|
+
export type ChannelCreateOptions = {
|
|
2565
2565
|
/**
|
|
2566
2566
|
* EXPERIMENTAL: Messaging protocols supported by the channel provider.
|
|
2567
2567
|
*/
|
|
@@ -2571,7 +2571,7 @@ export declare type ChannelCreateOptions = {
|
|
|
2571
2571
|
* Options provided on a client connection to a channel.
|
|
2572
2572
|
*
|
|
2573
2573
|
*/
|
|
2574
|
-
export
|
|
2574
|
+
export type ChannelConnectOptions = ChannelCreateOptions & {
|
|
2575
2575
|
/**
|
|
2576
2576
|
* @defaultValue true
|
|
2577
2577
|
*
|
|
@@ -2583,10 +2583,10 @@ export declare type ChannelConnectOptions = ChannelCreateOptions & {
|
|
|
2583
2583
|
*/
|
|
2584
2584
|
payload?: any;
|
|
2585
2585
|
};
|
|
2586
|
-
export
|
|
2586
|
+
export type ContextForIntent<MetadataType = any> = Context & {
|
|
2587
2587
|
metadata?: MetadataType;
|
|
2588
2588
|
};
|
|
2589
|
-
export
|
|
2589
|
+
export type InfoForIntentOptions<MetadataType = IntentMetadata> = {
|
|
2590
2590
|
/**
|
|
2591
2591
|
* Name of the intent to get info for.
|
|
2592
2592
|
*/
|
|
@@ -2594,14 +2594,14 @@ export declare type InfoForIntentOptions<MetadataType = IntentMetadata> = {
|
|
|
2594
2594
|
context?: Context;
|
|
2595
2595
|
metadata?: MetadataType;
|
|
2596
2596
|
};
|
|
2597
|
-
export
|
|
2597
|
+
export type FindIntentsByContextOptions<MetadataType = IntentMetadata> = {
|
|
2598
2598
|
context: Context;
|
|
2599
2599
|
metadata?: MetadataType;
|
|
2600
2600
|
};
|
|
2601
2601
|
/**
|
|
2602
2602
|
* Identity of a channel provider.
|
|
2603
2603
|
*/
|
|
2604
|
-
export
|
|
2604
|
+
export type ProviderIdentity = Identity & {
|
|
2605
2605
|
/**
|
|
2606
2606
|
* Identifier of the channel.
|
|
2607
2607
|
*/
|
|
@@ -2611,7 +2611,7 @@ export declare type ProviderIdentity = Identity & {
|
|
|
2611
2611
|
*/
|
|
2612
2612
|
channelName: string;
|
|
2613
2613
|
};
|
|
2614
|
-
export
|
|
2614
|
+
export type RegisterUsageData = {
|
|
2615
2615
|
data: unknown;
|
|
2616
2616
|
type: string;
|
|
2617
2617
|
};
|
|
@@ -2672,11 +2672,11 @@ export interface CloseWindowPayload {
|
|
|
2672
2672
|
skipBeforeUnload?: boolean;
|
|
2673
2673
|
};
|
|
2674
2674
|
}
|
|
2675
|
-
export
|
|
2675
|
+
export type ProxyInfo = {
|
|
2676
2676
|
config: ProxyConfig;
|
|
2677
2677
|
system: ProxySystemInfo;
|
|
2678
2678
|
};
|
|
2679
|
-
export
|
|
2679
|
+
export type ProxyConfig = {
|
|
2680
2680
|
/**
|
|
2681
2681
|
* The configured proxy address.
|
|
2682
2682
|
*/
|
|
@@ -2687,7 +2687,7 @@ export declare type ProxyConfig = {
|
|
|
2687
2687
|
proxyPort: number;
|
|
2688
2688
|
type: string;
|
|
2689
2689
|
};
|
|
2690
|
-
export
|
|
2690
|
+
export type ProxySystemInfo = {
|
|
2691
2691
|
/**
|
|
2692
2692
|
* The auto configuration url.
|
|
2693
2693
|
*/
|
|
@@ -2705,10 +2705,10 @@ export declare type ProxySystemInfo = {
|
|
|
2705
2705
|
*/
|
|
2706
2706
|
proxy: string;
|
|
2707
2707
|
};
|
|
2708
|
-
export
|
|
2709
|
-
export
|
|
2710
|
-
export
|
|
2711
|
-
export
|
|
2708
|
+
export type ChannelAction = (payload: unknown, id: ProviderIdentity | ClientIdentity) => unknown;
|
|
2709
|
+
export type ChannelMiddleware = (topic: string, payload: unknown, senderIdentity: ProviderIdentity | ClientIdentity) => Promise<unknown> | unknown;
|
|
2710
|
+
export type ErrorMiddleware = (topic: string, error: Error, id: ProviderIdentity | ClientIdentity) => unknown;
|
|
2711
|
+
export type ApplicationState = {
|
|
2712
2712
|
/**
|
|
2713
2713
|
* True when the application is a Platform controller
|
|
2714
2714
|
*/
|
|
@@ -2726,13 +2726,13 @@ export declare type ApplicationState = {
|
|
|
2726
2726
|
*/
|
|
2727
2727
|
parentUuid?: string;
|
|
2728
2728
|
};
|
|
2729
|
-
export
|
|
2729
|
+
export type InstalledApps = {
|
|
2730
2730
|
[key: string]: InstallationInfo;
|
|
2731
2731
|
};
|
|
2732
|
-
export
|
|
2732
|
+
export type InstallationInfo = {
|
|
2733
2733
|
cachedManifest: any;
|
|
2734
2734
|
};
|
|
2735
|
-
export
|
|
2735
|
+
export type GetLogRequestType = {
|
|
2736
2736
|
/**
|
|
2737
2737
|
* The name of the running application
|
|
2738
2738
|
*/
|
|
@@ -2746,7 +2746,7 @@ export declare type GetLogRequestType = {
|
|
|
2746
2746
|
*/
|
|
2747
2747
|
sizeLimit?: number;
|
|
2748
2748
|
};
|
|
2749
|
-
export
|
|
2749
|
+
export type LogInfo = {
|
|
2750
2750
|
/**
|
|
2751
2751
|
* The filename of the log
|
|
2752
2752
|
*/
|
|
@@ -2760,7 +2760,7 @@ export declare type LogInfo = {
|
|
|
2760
2760
|
*/
|
|
2761
2761
|
date: string;
|
|
2762
2762
|
};
|
|
2763
|
-
export
|
|
2763
|
+
export type SendApplicationLogResponse = {
|
|
2764
2764
|
logId: string;
|
|
2765
2765
|
};
|
|
2766
2766
|
/**
|
|
@@ -2772,27 +2772,27 @@ export declare type SendApplicationLogResponse = {
|
|
|
2772
2772
|
* `error` and above
|
|
2773
2773
|
* `fatal`: fatal only, indicates a crash is imminent
|
|
2774
2774
|
*/
|
|
2775
|
-
export
|
|
2776
|
-
export
|
|
2777
|
-
export
|
|
2775
|
+
export type LogLevel = 'verbose' | 'info' | 'warning' | 'error' | 'fatal';
|
|
2776
|
+
export type PermissionState = 'granted' | 'denied' | 'unavailable';
|
|
2777
|
+
export type RegistryInfo = {
|
|
2778
2778
|
data: any;
|
|
2779
2779
|
rootKey: string;
|
|
2780
2780
|
subkey: string;
|
|
2781
2781
|
type: string;
|
|
2782
2782
|
value: string;
|
|
2783
2783
|
};
|
|
2784
|
-
export
|
|
2784
|
+
export type ApplicationType = {
|
|
2785
2785
|
type: 'application' | 'external-app';
|
|
2786
2786
|
uuid: string;
|
|
2787
2787
|
};
|
|
2788
|
-
export
|
|
2788
|
+
export type WindowInfo = {
|
|
2789
2789
|
canNavigateBack: boolean;
|
|
2790
2790
|
canNavigateForward: boolean;
|
|
2791
2791
|
preloadScripts: Array<any>;
|
|
2792
2792
|
title: string;
|
|
2793
2793
|
url: string;
|
|
2794
2794
|
};
|
|
2795
|
-
export
|
|
2795
|
+
export type ApplicationWindowInfo = {
|
|
2796
2796
|
childWindows: Array<WindowDetail>;
|
|
2797
2797
|
mainWindow: WindowDetail;
|
|
2798
2798
|
/**
|
|
@@ -2800,7 +2800,7 @@ export declare type ApplicationWindowInfo = {
|
|
|
2800
2800
|
*/
|
|
2801
2801
|
uuid: string;
|
|
2802
2802
|
};
|
|
2803
|
-
export
|
|
2803
|
+
export type WindowDetail = {
|
|
2804
2804
|
/**
|
|
2805
2805
|
* The bottom-most coordinate of the window.
|
|
2806
2806
|
*/
|
|
@@ -2832,26 +2832,26 @@ export declare type WindowDetail = {
|
|
|
2832
2832
|
*/
|
|
2833
2833
|
width: number;
|
|
2834
2834
|
};
|
|
2835
|
-
export
|
|
2836
|
-
export
|
|
2835
|
+
export type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
|
|
2836
|
+
export type InitLayoutOptions = {
|
|
2837
2837
|
/**
|
|
2838
2838
|
* The id attribute of the container where the window's Layout should be initialized. If not provided
|
|
2839
2839
|
* then an element with id `layout-container` is used. We recommend using a div element.
|
|
2840
2840
|
*/
|
|
2841
2841
|
containerId?: string;
|
|
2842
2842
|
};
|
|
2843
|
-
export
|
|
2843
|
+
export type PresetLayoutOptions = {
|
|
2844
2844
|
/**
|
|
2845
2845
|
* Which preset layout arrangement to use.
|
|
2846
2846
|
* The preset options are `columns`, `grid`, `rows`, and `tabs`.
|
|
2847
2847
|
*/
|
|
2848
2848
|
presetType: LayoutPresetType;
|
|
2849
2849
|
};
|
|
2850
|
-
export
|
|
2851
|
-
export
|
|
2852
|
-
export
|
|
2853
|
-
export
|
|
2854
|
-
export
|
|
2850
|
+
export type ResultBehavior = 'close' | 'hide' | 'none';
|
|
2851
|
+
export type PopupBaseBehavior = 'close' | 'hide';
|
|
2852
|
+
export type PopupResultBehavior = 'none' | PopupBaseBehavior;
|
|
2853
|
+
export type PopupBlurBehavior = 'modal' | PopupBaseBehavior;
|
|
2854
|
+
export type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
|
|
2855
2855
|
export interface PopupOptions {
|
|
2856
2856
|
initialOptions?: Optional<WindowCreationOptions, 'name'>;
|
|
2857
2857
|
additionalOptions?: UpdatableWindowOptions;
|
|
@@ -2868,7 +2868,7 @@ export interface PopupOptions {
|
|
|
2868
2868
|
onPopupReady?: (popupWindow: _Window) => any;
|
|
2869
2869
|
onPopupResult?: (payload: PopupResult) => any;
|
|
2870
2870
|
}
|
|
2871
|
-
export
|
|
2871
|
+
export type PopupInteraction = 'clicked' | 'dismissed';
|
|
2872
2872
|
export interface PopupResult<T = any> {
|
|
2873
2873
|
identity: {
|
|
2874
2874
|
name: string;
|
|
@@ -2878,16 +2878,16 @@ export interface PopupResult<T = any> {
|
|
|
2878
2878
|
data?: T;
|
|
2879
2879
|
lastDispatchResult?: PopupResult;
|
|
2880
2880
|
}
|
|
2881
|
-
export
|
|
2881
|
+
export type AppVersionProgressEvent = {
|
|
2882
2882
|
type: 'app-version-progress';
|
|
2883
2883
|
} & AppVersionProgress;
|
|
2884
|
-
export
|
|
2884
|
+
export type AppVersionErrorEvent = {
|
|
2885
2885
|
type: 'app-version-error';
|
|
2886
2886
|
} & AppVersionError;
|
|
2887
|
-
export
|
|
2887
|
+
export type AppVersionCompleteEvent = {
|
|
2888
2888
|
type: 'app-version-complete';
|
|
2889
2889
|
} & AppVersionProgress;
|
|
2890
|
-
export
|
|
2890
|
+
export type AppVersionRuntimeStatusEvent = {
|
|
2891
2891
|
type: 'runtime-status';
|
|
2892
2892
|
} & AppVersionRuntimeInfo;
|
|
2893
2893
|
import type * as BaseEvents from './api/events/base';
|
|
@@ -2901,20 +2901,20 @@ import type * as FrameEvents from './api/events/frame';
|
|
|
2901
2901
|
import type * as PlatformEvents from './api/events/platform';
|
|
2902
2902
|
import type * as ExternalApplicationEvents from './api/events/externalApplication';
|
|
2903
2903
|
export type { BaseEvents, WebContentsEvents, SystemEvents, ApplicationEvents, WindowEvents, ViewEvents, GlobalHotkeyEvents, FrameEvents, PlatformEvents, ExternalApplicationEvents };
|
|
2904
|
-
export
|
|
2905
|
-
export
|
|
2906
|
-
export
|
|
2907
|
-
export
|
|
2908
|
-
export
|
|
2909
|
-
export
|
|
2910
|
-
export
|
|
2911
|
-
export
|
|
2912
|
-
export
|
|
2913
|
-
export
|
|
2904
|
+
export type BaseEvent = BaseEvents.BaseEvent;
|
|
2905
|
+
export type WebContentsEvent = WebContentsEvents.WebContentsEvent;
|
|
2906
|
+
export type SystemEvent = SystemEvents.SystemEvent;
|
|
2907
|
+
export type ApplicationEvent = ApplicationEvents.ApplicationEvent;
|
|
2908
|
+
export type WindowEvent = WindowEvents.WindowEvent;
|
|
2909
|
+
export type ViewEvent = ViewEvents.ViewEvent;
|
|
2910
|
+
export type GlobalHotkeyEvent = GlobalHotkeyEvents.GlobalHotkeyEvent;
|
|
2911
|
+
export type FrameEvent = FrameEvents.FrameEvent;
|
|
2912
|
+
export type PlatformEvent = PlatformEvents.PlatformEvent;
|
|
2913
|
+
export type ExternalApplicationEvent = ExternalApplicationEvents.ExternalApplicationEvent;
|
|
2914
2914
|
/**
|
|
2915
2915
|
* Configure the context menu when right-clicking on a window.
|
|
2916
2916
|
*/
|
|
2917
|
-
export
|
|
2917
|
+
export type ContextMenuOptions = {
|
|
2918
2918
|
/**
|
|
2919
2919
|
* Context menu items to display on right-click.
|
|
2920
2920
|
*/
|
|
@@ -2927,16 +2927,16 @@ export declare type ContextMenuOptions = {
|
|
|
2927
2927
|
/**
|
|
2928
2928
|
* Context menu item with an implementation provided by OpenFin.
|
|
2929
2929
|
*/
|
|
2930
|
-
export
|
|
2931
|
-
export
|
|
2930
|
+
export type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | 'copy' | 'paste' | 'selectAll' | 'spellCheck' | 'inspect' | 'reload' | 'navigateForward' | 'navigateBack' | 'print';
|
|
2931
|
+
export type InteropBrokerDisconnectionEvent = {
|
|
2932
2932
|
type: string;
|
|
2933
2933
|
topic: string;
|
|
2934
2934
|
brokerName: string;
|
|
2935
2935
|
};
|
|
2936
|
-
export
|
|
2936
|
+
export type InteropClientOnDisconnectionListener = (InteropBrokerDisconnectionEvent: InteropBrokerDisconnectionEvent) => any;
|
|
2937
2937
|
export interface InteropActionLoggingOption {
|
|
2938
2938
|
enabled: boolean;
|
|
2939
2939
|
}
|
|
2940
|
-
export
|
|
2941
|
-
export
|
|
2940
|
+
export type InteropLoggingActions = 'beforeAction' | 'afterAction';
|
|
2941
|
+
export type InteropLoggingOptions = Record<InteropLoggingActions, InteropActionLoggingOption>;
|
|
2942
2942
|
export type { Me } from './api/me';
|