@openfin/core 29.73.8 → 29.73.10
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/OpenFin.d.ts +4 -3
- package/package.json +1 -1
- package/src/api/interop/Factory.d.ts +0 -1
- package/src/api/interop/Factory.js +0 -1
- package/src/api/interop/fdc3/overrideCheck.d.ts +0 -1
- package/src/OpenFin.d.ts +0 -1455
- package/src/OpenFin.js +0 -4
package/src/OpenFin.d.ts
DELETED
|
@@ -1,1455 +0,0 @@
|
|
|
1
|
-
import type { Application } from './api/application';
|
|
2
|
-
import { ApplicationEvents } from './api/events/application';
|
|
3
|
-
import { ExternalApplicationEvents } from './api/events/externalApplication';
|
|
4
|
-
import { FrameEvents } from './api/events/frame';
|
|
5
|
-
import { GlobalHotkeyEvents } from './api/events/globalHotkey';
|
|
6
|
-
import { PlatformEvents } from './api/events/platform';
|
|
7
|
-
import { SystemEvents } from './api/events/system';
|
|
8
|
-
import { ViewEvents } from './api/events/view';
|
|
9
|
-
import { WindowEvents, WindowOptionsChangedEvent } from './api/events/window';
|
|
10
|
-
import type { ExternalApplication } from './api/external-application';
|
|
11
|
-
import { FinApi } from './api/fin';
|
|
12
|
-
import type { _Frame } from './api/frame';
|
|
13
|
-
import type ChannelClient from './api/interappbus/channel/client';
|
|
14
|
-
import { MessagingProtocols } from './api/interappbus/channel/protocols';
|
|
15
|
-
import type { ChannelProvider } from './api/interappbus/channel/provider';
|
|
16
|
-
import type { InteropBroker, InteropClient } from './api/interop';
|
|
17
|
-
import type { Platform } from './api/platform';
|
|
18
|
-
import type { Layout } from './api/platform/layout';
|
|
19
|
-
import { SnapshotSource } from './api/snapshot-source';
|
|
20
|
-
import type { View } from './api/view';
|
|
21
|
-
import { _Window } from './api/window';
|
|
22
|
-
export declare type Fin<MeType extends EntityType = 'window' | 'view'> = FinApi<MeType>;
|
|
23
|
-
export type { Application, ExternalApplication, _Frame as Frame, ChannelClient, ChannelProvider, Platform, Layout, View, _Window as Window, InteropClient, InteropBroker, SnapshotSource };
|
|
24
|
-
export declare type WebContent = View | _Window;
|
|
25
|
-
export declare type ApplicationIdentity = {
|
|
26
|
-
uuid: string;
|
|
27
|
-
};
|
|
28
|
-
export declare type Identity = {
|
|
29
|
-
uuid: string;
|
|
30
|
-
name: string;
|
|
31
|
-
};
|
|
32
|
-
export declare type ClientIdentity = {
|
|
33
|
-
uuid: string;
|
|
34
|
-
name: string;
|
|
35
|
-
endpointId: string;
|
|
36
|
-
isLocalEndpointId: boolean;
|
|
37
|
-
};
|
|
38
|
-
export declare type ClientInfo = Omit<ClientIdentity, 'isLocalEndpointId'> & {
|
|
39
|
-
entityType: EntityType;
|
|
40
|
-
connectionUrl: string;
|
|
41
|
-
};
|
|
42
|
-
export declare type ClientIdentityMultiRuntime = ClientIdentity & {
|
|
43
|
-
runtimeUuid: string;
|
|
44
|
-
};
|
|
45
|
-
export declare type EntityInfo = {
|
|
46
|
-
uuid: string;
|
|
47
|
-
name: string;
|
|
48
|
-
entityType: EntityType;
|
|
49
|
-
};
|
|
50
|
-
export declare type EntityType = 'window' | 'iframe' | 'external connection' | 'view' | 'unknown';
|
|
51
|
-
export declare type Bounds = {
|
|
52
|
-
top: number;
|
|
53
|
-
left: number;
|
|
54
|
-
height: number;
|
|
55
|
-
width: number;
|
|
56
|
-
};
|
|
57
|
-
/**
|
|
58
|
-
* Returned from getBounds call. bottom and right are never used for setting.
|
|
59
|
-
*/
|
|
60
|
-
export declare type WindowBounds = Bounds & {
|
|
61
|
-
bottom: number;
|
|
62
|
-
right: number;
|
|
63
|
-
};
|
|
64
|
-
export declare type Rectangle = {
|
|
65
|
-
x: number;
|
|
66
|
-
y: number;
|
|
67
|
-
width: number;
|
|
68
|
-
height: number;
|
|
69
|
-
};
|
|
70
|
-
export declare type ApplicationCreationOptions = Partial<ApplicationOptions> & {
|
|
71
|
-
name: string;
|
|
72
|
-
uuid: string;
|
|
73
|
-
};
|
|
74
|
-
export declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
75
|
-
disableIabSecureLogging: boolean;
|
|
76
|
-
loadErrorMessage: string;
|
|
77
|
-
mainWindowOptions: WindowCreationOptions;
|
|
78
|
-
name: string;
|
|
79
|
-
nonPersistent: boolean;
|
|
80
|
-
plugins: boolean;
|
|
81
|
-
spellCheck: boolean;
|
|
82
|
-
url: string;
|
|
83
|
-
uuid: string;
|
|
84
|
-
webSecurity: boolean;
|
|
85
|
-
commands: ShortcutOverride[];
|
|
86
|
-
isPlatformController: boolean;
|
|
87
|
-
maxViewPoolSize: number;
|
|
88
|
-
defaultWindowOptions: Partial<WindowOptions>;
|
|
89
|
-
defaultViewOptions: Partial<ViewOptions>;
|
|
90
|
-
snapshot: Snapshot;
|
|
91
|
-
preventQuitOnLastWindowClosed: boolean;
|
|
92
|
-
interopBrokerConfiguration: InteropBrokerOptions;
|
|
93
|
-
apiDiagnostics: boolean;
|
|
94
|
-
defaultDomainSettings: DefaultDomainSettings;
|
|
95
|
-
enableJumpList: boolean;
|
|
96
|
-
enableBeforeUnload: boolean;
|
|
97
|
-
};
|
|
98
|
-
declare type InteropBrokerOptions = {
|
|
99
|
-
contextGroups?: ContextGroupInfo;
|
|
100
|
-
logging?: InteropLoggingOptions;
|
|
101
|
-
};
|
|
102
|
-
export declare type ContextGroupInfo = {
|
|
103
|
-
id: string;
|
|
104
|
-
displayMetadata?: DisplayMetadata;
|
|
105
|
-
};
|
|
106
|
-
export declare type DisplayMetadata = {
|
|
107
|
-
/**
|
|
108
|
-
* A user-readable name for this context group, e.g: `"Red"`
|
|
109
|
-
*/
|
|
110
|
-
readonly name?: string;
|
|
111
|
-
/**
|
|
112
|
-
* The color that should be associated within this context group when displaying this context group in a UI, e.g: `0xFF0000`.
|
|
113
|
-
*/
|
|
114
|
-
readonly color?: string;
|
|
115
|
-
/**
|
|
116
|
-
* A URL of an image that can be used to display this context group
|
|
117
|
-
*/
|
|
118
|
-
readonly glyph?: string;
|
|
119
|
-
};
|
|
120
|
-
export declare type LegacyWinOptionsInAppOptions = Pick<WindowCreationOptions, 'accelerator' | 'alwaysOnTop' | 'api' | 'aspectRatio' | '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'>;
|
|
121
|
-
export declare type Snapshot = {
|
|
122
|
-
windows: WindowCreationOptions[];
|
|
123
|
-
snapshotDetails?: {
|
|
124
|
-
monitorInfo: MonitorInfo;
|
|
125
|
-
runtimeVersion: string;
|
|
126
|
-
timestamp: string;
|
|
127
|
-
};
|
|
128
|
-
interopSnapshotDetails?: {
|
|
129
|
-
contextGroupStates: ContextGroupStates;
|
|
130
|
-
};
|
|
131
|
-
};
|
|
132
|
-
export declare type ContextGroupStates = {
|
|
133
|
-
[key: string]: {
|
|
134
|
-
[key: string]: Context;
|
|
135
|
-
};
|
|
136
|
-
};
|
|
137
|
-
export declare type Context = {
|
|
138
|
-
id?: {
|
|
139
|
-
[key: string]: string;
|
|
140
|
-
};
|
|
141
|
-
name?: string;
|
|
142
|
-
type: string;
|
|
143
|
-
};
|
|
144
|
-
export declare type MonitorInfo = {
|
|
145
|
-
deviceScaleFactor: number;
|
|
146
|
-
dpi: Point;
|
|
147
|
-
nonPrimaryMonitors: MonitorDetails[];
|
|
148
|
-
primaryMonitor: MonitorDetails;
|
|
149
|
-
reason: string;
|
|
150
|
-
taskbar: TaskBar;
|
|
151
|
-
virtualScreen: DipRect;
|
|
152
|
-
};
|
|
153
|
-
export declare type Point = {
|
|
154
|
-
x: number;
|
|
155
|
-
y: number;
|
|
156
|
-
};
|
|
157
|
-
export declare type PointTopLeft = {
|
|
158
|
-
top: number;
|
|
159
|
-
left: number;
|
|
160
|
-
};
|
|
161
|
-
export declare type RectangleByEdgePositions = {
|
|
162
|
-
top: number;
|
|
163
|
-
left: number;
|
|
164
|
-
bottom: number;
|
|
165
|
-
right: number;
|
|
166
|
-
};
|
|
167
|
-
export declare type MonitorDetails = {
|
|
168
|
-
available: DipScaleRects;
|
|
169
|
-
availableRect: RectangleByEdgePositions;
|
|
170
|
-
deviceId: string | number;
|
|
171
|
-
displayDeviceActive: boolean;
|
|
172
|
-
deviceScaleFactor: number;
|
|
173
|
-
monitorRect: RectangleByEdgePositions;
|
|
174
|
-
name: string | number;
|
|
175
|
-
dpi: Point;
|
|
176
|
-
monitor: DipScaleRects;
|
|
177
|
-
};
|
|
178
|
-
export declare type DipRect = RectangleByEdgePositions & {
|
|
179
|
-
dipRect: RectangleByEdgePositions;
|
|
180
|
-
scaledRect: RectangleByEdgePositions;
|
|
181
|
-
};
|
|
182
|
-
export declare type DipScaleRects = {
|
|
183
|
-
dipRect: RectangleByEdgePositions;
|
|
184
|
-
scaledRect: RectangleByEdgePositions;
|
|
185
|
-
};
|
|
186
|
-
export declare type TaskBar = DipScaleRects & {
|
|
187
|
-
edge: string;
|
|
188
|
-
rect: RectangleByEdgePositions;
|
|
189
|
-
};
|
|
190
|
-
export declare type WindowCreationOptions = Partial<WindowOptions> & {
|
|
191
|
-
name: string;
|
|
192
|
-
};
|
|
193
|
-
export declare type UpdatableWindowOptions = Partial<MutableWindowOptions>;
|
|
194
|
-
export declare type WindowOptions = MutableWindowOptions & ConstWindowOptions;
|
|
195
|
-
export declare type ViewVisibilityOption = {
|
|
196
|
-
enabled?: boolean;
|
|
197
|
-
};
|
|
198
|
-
export declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
|
|
199
|
-
paintIntervalMs?: number;
|
|
200
|
-
};
|
|
201
|
-
export declare type ViewVisibilityOptions = {
|
|
202
|
-
showViewsOnWindowResize?: ShowViewOnWindowResizeOptions;
|
|
203
|
-
showViewsOnSplitterDrag?: ViewVisibilityOption;
|
|
204
|
-
showViewsOnTabDrag?: ViewVisibilityOption;
|
|
205
|
-
};
|
|
206
|
-
export declare type WindowState = 'maximized' | 'minimized' | 'normal';
|
|
207
|
-
export declare type ConstWindowOptions = {
|
|
208
|
-
accelerator: Partial<Accelerator>;
|
|
209
|
-
api: Api;
|
|
210
|
-
applicationIcon: string;
|
|
211
|
-
autoShow: boolean;
|
|
212
|
-
backgroundColor: string;
|
|
213
|
-
contentCreation: ContentCreationOptions;
|
|
214
|
-
contentNavigation: ContentNavigation;
|
|
215
|
-
contentRedirect: Partial<ContentRedirect>;
|
|
216
|
-
customRequestHeaders: CustomRequestHeaders[];
|
|
217
|
-
closeOnLastViewRemoved: boolean;
|
|
218
|
-
defaultCentered: boolean;
|
|
219
|
-
defaultHeight: number;
|
|
220
|
-
defaultLeft: number;
|
|
221
|
-
defaultTop: number;
|
|
222
|
-
defaultWidth: number;
|
|
223
|
-
height: number;
|
|
224
|
-
layout: any;
|
|
225
|
-
modalParentIdentity: Identity;
|
|
226
|
-
name: string;
|
|
227
|
-
permissions: Partial<Permissions>;
|
|
228
|
-
preloadScripts: PreloadScript[];
|
|
229
|
-
processAffinity: string;
|
|
230
|
-
saveWindowState: boolean;
|
|
231
|
-
shadow: boolean;
|
|
232
|
-
ignoreSavedWindowState: boolean;
|
|
233
|
-
smallWindow: boolean;
|
|
234
|
-
state: WindowState;
|
|
235
|
-
taskbarIcon: string;
|
|
236
|
-
taskbarIconGroup: string;
|
|
237
|
-
url: string;
|
|
238
|
-
uuid: string;
|
|
239
|
-
waitForPageLoad: boolean;
|
|
240
|
-
width: number;
|
|
241
|
-
x: number;
|
|
242
|
-
y: number;
|
|
243
|
-
experimental?: any;
|
|
244
|
-
fdc3InteropApi?: string;
|
|
245
|
-
viewVisibility?: ViewVisibilityOptions;
|
|
246
|
-
};
|
|
247
|
-
export declare type MutableWindowOptions = {
|
|
248
|
-
alphaMask: RGB;
|
|
249
|
-
alwaysOnTop: boolean;
|
|
250
|
-
aspectRatio: number;
|
|
251
|
-
contextMenu: boolean;
|
|
252
|
-
contextMenuSettings: ContextMenuSettings;
|
|
253
|
-
contextMenuOptions: ContextMenuOptions;
|
|
254
|
-
cornerRounding: Partial<CornerRounding>;
|
|
255
|
-
customContext: any;
|
|
256
|
-
customData: any;
|
|
257
|
-
frame: boolean;
|
|
258
|
-
hideOnClose: boolean;
|
|
259
|
-
hotkeys: Hotkey[];
|
|
260
|
-
icon: string;
|
|
261
|
-
includeInSnapshots: boolean;
|
|
262
|
-
maxHeight: number;
|
|
263
|
-
maximizable: boolean;
|
|
264
|
-
maxWidth: number;
|
|
265
|
-
minHeight: number;
|
|
266
|
-
minimizable: boolean;
|
|
267
|
-
minWidth: number;
|
|
268
|
-
opacity: number;
|
|
269
|
-
resizable: boolean;
|
|
270
|
-
resizeRegion: ResizeRegion;
|
|
271
|
-
showBackgroundImages: boolean;
|
|
272
|
-
showTaskbarIcon: boolean;
|
|
273
|
-
interop: InteropConfig;
|
|
274
|
-
workspacePlatform: WorkspacePlatformOptions;
|
|
275
|
-
};
|
|
276
|
-
export declare type WorkspacePlatformOptions = {
|
|
277
|
-
/** Leaving this as any for now until we figure out what the shape should look like in Workspace */
|
|
278
|
-
[key: string]: any;
|
|
279
|
-
};
|
|
280
|
-
export declare type WebRequestHeader = {
|
|
281
|
-
[key: string]: string;
|
|
282
|
-
};
|
|
283
|
-
export declare type CustomRequestHeaders = {
|
|
284
|
-
urlPatterns: string[];
|
|
285
|
-
headers: WebRequestHeader[];
|
|
286
|
-
};
|
|
287
|
-
export declare type WindowOptionDiff = {
|
|
288
|
-
[key in keyof WindowOptions]: {
|
|
289
|
-
oldVal: WindowOptions[key];
|
|
290
|
-
newVal: WindowOptions[key];
|
|
291
|
-
};
|
|
292
|
-
};
|
|
293
|
-
export declare type ResizeRegion = {
|
|
294
|
-
size?: number;
|
|
295
|
-
bottomRightCorner?: number;
|
|
296
|
-
sides?: {
|
|
297
|
-
top?: boolean;
|
|
298
|
-
bottom?: boolean;
|
|
299
|
-
left?: boolean;
|
|
300
|
-
right?: boolean;
|
|
301
|
-
};
|
|
302
|
-
};
|
|
303
|
-
export declare type Accelerator = {
|
|
304
|
-
devtools: boolean;
|
|
305
|
-
reload: boolean;
|
|
306
|
-
reloadIgnoringCache: boolean;
|
|
307
|
-
zoom: boolean;
|
|
308
|
-
};
|
|
309
|
-
export declare type Api = {
|
|
310
|
-
iframe?: {
|
|
311
|
-
crossOriginInjection?: boolean;
|
|
312
|
-
sameOriginInjection?: boolean;
|
|
313
|
-
enableDeprecatedSharedName?: boolean;
|
|
314
|
-
};
|
|
315
|
-
};
|
|
316
|
-
export declare type ContentNavigation = {
|
|
317
|
-
whitelist?: string[];
|
|
318
|
-
blacklist?: string[];
|
|
319
|
-
};
|
|
320
|
-
export declare type ContentRedirect = {
|
|
321
|
-
whitelist: string[];
|
|
322
|
-
blacklist: string[];
|
|
323
|
-
};
|
|
324
|
-
export declare type CornerRounding = {
|
|
325
|
-
height: number;
|
|
326
|
-
width: number;
|
|
327
|
-
};
|
|
328
|
-
export declare type DownloadPreloadOption = {
|
|
329
|
-
url: string;
|
|
330
|
-
};
|
|
331
|
-
export declare type DownloadPreloadInfo = {
|
|
332
|
-
success: boolean;
|
|
333
|
-
url?: string;
|
|
334
|
-
error: string;
|
|
335
|
-
};
|
|
336
|
-
export declare type RGB = {
|
|
337
|
-
red: number;
|
|
338
|
-
blue: number;
|
|
339
|
-
green: number;
|
|
340
|
-
};
|
|
341
|
-
export declare type ContextMenuSettings = {
|
|
342
|
-
enable: boolean;
|
|
343
|
-
devtools?: boolean;
|
|
344
|
-
reload?: boolean;
|
|
345
|
-
};
|
|
346
|
-
export declare type Hotkey = {
|
|
347
|
-
keys: string;
|
|
348
|
-
preventDefault?: boolean;
|
|
349
|
-
};
|
|
350
|
-
export declare type ShortcutOverride = Hotkey & {
|
|
351
|
-
command: string;
|
|
352
|
-
};
|
|
353
|
-
export declare type PreloadScript = {
|
|
354
|
-
mandatory?: boolean;
|
|
355
|
-
state?: 'load-started' | 'load-failed' | 'load-succeeded' | 'failed' | 'succeeded';
|
|
356
|
-
url: string;
|
|
357
|
-
};
|
|
358
|
-
export declare type AutoResizeOptions = {
|
|
359
|
-
/**
|
|
360
|
-
* If true, the view's width will grow and shrink together with the window. false
|
|
361
|
-
* by default.
|
|
362
|
-
*/
|
|
363
|
-
width?: boolean;
|
|
364
|
-
/**
|
|
365
|
-
* If true, the view's height will grow and shrink together with the window. false
|
|
366
|
-
* by default.
|
|
367
|
-
*/
|
|
368
|
-
height?: boolean;
|
|
369
|
-
/**
|
|
370
|
-
* If true, the view's x position and width will grow and shrink proportionally with
|
|
371
|
-
* the window. false by default.
|
|
372
|
-
*/
|
|
373
|
-
horizontal?: boolean;
|
|
374
|
-
/**
|
|
375
|
-
* If true, the view's y position and height will grow and shrink proportionally with
|
|
376
|
-
* the window. false by default.
|
|
377
|
-
*/
|
|
378
|
-
vertical?: boolean;
|
|
379
|
-
};
|
|
380
|
-
export declare type InteropConfig = {
|
|
381
|
-
currentContextGroup?: string | null;
|
|
382
|
-
providerId?: string;
|
|
383
|
-
};
|
|
384
|
-
export declare type ViewInfo = {
|
|
385
|
-
canNavigateBack: boolean;
|
|
386
|
-
canNavigateForward: boolean;
|
|
387
|
-
processAffinity: string;
|
|
388
|
-
title: string;
|
|
389
|
-
url: string;
|
|
390
|
-
favicons: string[];
|
|
391
|
-
};
|
|
392
|
-
export declare type UpdatableViewOptions = Partial<MutableViewOptions>;
|
|
393
|
-
export declare type ViewCreationOptions = Partial<ViewOptions> & {
|
|
394
|
-
name: string;
|
|
395
|
-
url: string;
|
|
396
|
-
target: Identity;
|
|
397
|
-
};
|
|
398
|
-
export declare type MutableViewOptions = {
|
|
399
|
-
autoResize: AutoResizeOptions;
|
|
400
|
-
contextMenu: boolean;
|
|
401
|
-
contextMenuSettings: ContextMenuSettings;
|
|
402
|
-
contextMenuOptions: ContextMenuOptions;
|
|
403
|
-
backgroundColor: string;
|
|
404
|
-
customData: any;
|
|
405
|
-
customContext: any;
|
|
406
|
-
api: Api;
|
|
407
|
-
contentNavigation: ContentNavigation;
|
|
408
|
-
detachOnClose: boolean;
|
|
409
|
-
isClosable: boolean;
|
|
410
|
-
preventDragOut: boolean;
|
|
411
|
-
interop?: InteropConfig;
|
|
412
|
-
};
|
|
413
|
-
export declare type ViewOptions = ConstViewOptions & MutableViewOptions;
|
|
414
|
-
export declare type ConstViewOptions = {
|
|
415
|
-
name: string;
|
|
416
|
-
url: string;
|
|
417
|
-
target: Identity;
|
|
418
|
-
contentCreation: ContentCreationOptions;
|
|
419
|
-
customRequestHeaders: CustomRequestHeaders[];
|
|
420
|
-
bounds: Bounds;
|
|
421
|
-
permissions: Partial<Permissions>;
|
|
422
|
-
processAffinity: string;
|
|
423
|
-
hotkeys: Hotkey[];
|
|
424
|
-
preloadScripts: PreloadScript[];
|
|
425
|
-
manifestUrl: string;
|
|
426
|
-
zoomLevel: number;
|
|
427
|
-
experimental: any;
|
|
428
|
-
fdc3InteropApi?: string;
|
|
429
|
-
enableBeforeUnload: boolean;
|
|
430
|
-
accelerator?: Partial<Accelerator>;
|
|
431
|
-
};
|
|
432
|
-
export declare type ViewState = ViewCreationOptions & {
|
|
433
|
-
backgroundThrottling: boolean;
|
|
434
|
-
componentName: 'view';
|
|
435
|
-
initialUrl: string;
|
|
436
|
-
minWidth?: number;
|
|
437
|
-
};
|
|
438
|
-
export declare type Certificate = {
|
|
439
|
-
data: string;
|
|
440
|
-
fingerprint: string;
|
|
441
|
-
issuer: CertificatePrincipal;
|
|
442
|
-
issuerCert: Certificate;
|
|
443
|
-
issuerName: string;
|
|
444
|
-
serialNumber: string;
|
|
445
|
-
subject: CertificatePrincipal;
|
|
446
|
-
subjectName: string;
|
|
447
|
-
validExpiry: number;
|
|
448
|
-
validStart: number;
|
|
449
|
-
};
|
|
450
|
-
declare type CertificatePrincipal = {
|
|
451
|
-
commonName: string;
|
|
452
|
-
country: string;
|
|
453
|
-
locality: string;
|
|
454
|
-
organizations: string[];
|
|
455
|
-
organizationUnits: string[];
|
|
456
|
-
state: string;
|
|
457
|
-
};
|
|
458
|
-
export declare type HostContextChangedPayload = {
|
|
459
|
-
context: any;
|
|
460
|
-
reason: HostContextChangedReasons;
|
|
461
|
-
};
|
|
462
|
-
export declare type ApplySnapshotOptions = {
|
|
463
|
-
closeExistingWindows?: boolean;
|
|
464
|
-
closeSnapshotWindows?: boolean;
|
|
465
|
-
skipOutOfBoundsCheck?: boolean;
|
|
466
|
-
};
|
|
467
|
-
export declare type ApplySnapshotPayload = {
|
|
468
|
-
snapshot: Snapshot;
|
|
469
|
-
options?: ApplySnapshotOptions;
|
|
470
|
-
};
|
|
471
|
-
export declare type CreateViewPayload = {
|
|
472
|
-
opts: Partial<ViewOptions>;
|
|
473
|
-
target: Identity;
|
|
474
|
-
targetView?: Identity;
|
|
475
|
-
};
|
|
476
|
-
export declare type ReplaceViewPayload = {
|
|
477
|
-
opts: {
|
|
478
|
-
viewToReplace: Identity;
|
|
479
|
-
newView: Partial<ViewOptions>;
|
|
480
|
-
};
|
|
481
|
-
target: Identity;
|
|
482
|
-
};
|
|
483
|
-
export declare type CloseViewPayload = {
|
|
484
|
-
view: Identity;
|
|
485
|
-
};
|
|
486
|
-
export declare type FetchManifestPayload = {
|
|
487
|
-
manifestUrl: string;
|
|
488
|
-
};
|
|
489
|
-
export declare type ReplaceLayoutOpts = {
|
|
490
|
-
layout: LayoutOptions;
|
|
491
|
-
};
|
|
492
|
-
export declare type ReplaceLayoutPayload = {
|
|
493
|
-
opts: ReplaceLayoutOpts;
|
|
494
|
-
target: Identity;
|
|
495
|
-
};
|
|
496
|
-
export declare type SetWindowContextPayload = {
|
|
497
|
-
context: any;
|
|
498
|
-
entityType: EntityType;
|
|
499
|
-
target: Identity;
|
|
500
|
-
};
|
|
501
|
-
export declare type LaunchIntoPlatformPayload = {
|
|
502
|
-
manifest: any;
|
|
503
|
-
};
|
|
504
|
-
export declare type GetWindowContextPayload = {
|
|
505
|
-
entityType: EntityType;
|
|
506
|
-
target: Identity;
|
|
507
|
-
};
|
|
508
|
-
export declare type ApplicationPermissions = {
|
|
509
|
-
setFileDownloadLocation: boolean;
|
|
510
|
-
};
|
|
511
|
-
export declare type LaunchExternalProcessRule = {
|
|
512
|
-
behavior: 'allow' | 'block';
|
|
513
|
-
match: string[];
|
|
514
|
-
};
|
|
515
|
-
export declare type SystemPermissions = {
|
|
516
|
-
getAllExternalWindows: boolean;
|
|
517
|
-
launchExternalProcess: boolean | {
|
|
518
|
-
assets: {
|
|
519
|
-
enabled: boolean;
|
|
520
|
-
srcRules?: LaunchExternalProcessRule[];
|
|
521
|
-
};
|
|
522
|
-
downloads: {
|
|
523
|
-
enabled: boolean;
|
|
524
|
-
};
|
|
525
|
-
executables: {
|
|
526
|
-
enabled: boolean;
|
|
527
|
-
pathRules?: LaunchExternalProcessRule[];
|
|
528
|
-
};
|
|
529
|
-
};
|
|
530
|
-
readRegistryValue: boolean | {
|
|
531
|
-
enabled: boolean;
|
|
532
|
-
registryKeys: string[];
|
|
533
|
-
};
|
|
534
|
-
terminateExternalProcess: boolean;
|
|
535
|
-
openUrlWithBrowser: {
|
|
536
|
-
enabled: boolean;
|
|
537
|
-
protocols: string[];
|
|
538
|
-
};
|
|
539
|
-
};
|
|
540
|
-
export declare type WebPermission = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write';
|
|
541
|
-
export declare type Permissions = {
|
|
542
|
-
Application?: Partial<ApplicationPermissions>;
|
|
543
|
-
System?: Partial<SystemPermissions>;
|
|
544
|
-
webAPIs?: WebPermission[];
|
|
545
|
-
};
|
|
546
|
-
export declare type PlatformWindowCreationOptions = Partial<WindowCreationOptions> & {
|
|
547
|
-
updateStateIfExists?: boolean;
|
|
548
|
-
reason?: WindowCreationReason;
|
|
549
|
-
};
|
|
550
|
-
export declare type PlatformWindowOptions = WindowCreationOptions & {
|
|
551
|
-
stylesheetUrl: string;
|
|
552
|
-
};
|
|
553
|
-
export declare type PlatformViewCreationOptions = Partial<ViewOptions> & {
|
|
554
|
-
url: string;
|
|
555
|
-
target: Identity;
|
|
556
|
-
};
|
|
557
|
-
export declare type ProcessAffinityStrategy = 'same' | 'different';
|
|
558
|
-
export declare type PlatformOptions = ApplicationCreationOptions & {
|
|
559
|
-
defaultWindowOptions?: Partial<PlatformWindowOptions>;
|
|
560
|
-
defaultViewOptions?: Partial<PlatformViewCreationOptions>;
|
|
561
|
-
disableDefaultCommands?: boolean;
|
|
562
|
-
viewProcessAffinityStrategy?: ProcessAffinityStrategy;
|
|
563
|
-
providerUrl?: string;
|
|
564
|
-
permissions?: Partial<Permissions>;
|
|
565
|
-
};
|
|
566
|
-
export declare type Manifest = {
|
|
567
|
-
appAssets?: {
|
|
568
|
-
alias: string;
|
|
569
|
-
args?: string;
|
|
570
|
-
src: string;
|
|
571
|
-
target?: string;
|
|
572
|
-
version: string;
|
|
573
|
-
}[];
|
|
574
|
-
assetsUrl?: string;
|
|
575
|
-
devtools_port?: number;
|
|
576
|
-
dialogSettings?: {
|
|
577
|
-
bgColor?: number;
|
|
578
|
-
logo?: string;
|
|
579
|
-
progressBarBgColor?: number;
|
|
580
|
-
progressBarBorderColor?: number;
|
|
581
|
-
progressBarFillColor?: number;
|
|
582
|
-
textColor?: number;
|
|
583
|
-
};
|
|
584
|
-
licenseKey: string;
|
|
585
|
-
offlineAccess?: boolean;
|
|
586
|
-
platform?: PlatformOptions;
|
|
587
|
-
proxy?: {
|
|
588
|
-
proxyAddress: string;
|
|
589
|
-
proxyPort: number;
|
|
590
|
-
type: string;
|
|
591
|
-
};
|
|
592
|
-
runtime: {
|
|
593
|
-
arguments?: string;
|
|
594
|
-
fallbackVersion?: string;
|
|
595
|
-
forceLatest?: boolean;
|
|
596
|
-
futureVersion?: string;
|
|
597
|
-
version: string;
|
|
598
|
-
};
|
|
599
|
-
services?: string[];
|
|
600
|
-
shortcut?: {
|
|
601
|
-
'company': string;
|
|
602
|
-
'description'?: string;
|
|
603
|
-
'force'?: boolean;
|
|
604
|
-
'icon': string;
|
|
605
|
-
'name': string;
|
|
606
|
-
'startMenuRootFolder'?: string;
|
|
607
|
-
'target'?: ('desktop' | 'start-menu' | 'automatic-start-up')[];
|
|
608
|
-
'uninstall-shortcut'?: boolean;
|
|
609
|
-
};
|
|
610
|
-
snapshot?: Snapshot;
|
|
611
|
-
splashScreenImage?: string;
|
|
612
|
-
startup_app: WindowOptions;
|
|
613
|
-
supportInformation?: {
|
|
614
|
-
company: string;
|
|
615
|
-
email: string;
|
|
616
|
-
product: string;
|
|
617
|
-
forwardErrorReports?: boolean;
|
|
618
|
-
enableErrorReporting?: boolean;
|
|
619
|
-
};
|
|
620
|
-
interopBrokerConfiguration: InteropBrokerOptions;
|
|
621
|
-
};
|
|
622
|
-
export declare type LayoutContent = (LayoutItemConfig | LayoutRow | LayoutColumn | LayoutComponent)[];
|
|
623
|
-
export declare type LayoutItemConfig = {
|
|
624
|
-
type: string;
|
|
625
|
-
content?: LayoutContent;
|
|
626
|
-
width?: number;
|
|
627
|
-
height?: number;
|
|
628
|
-
id?: string | string[];
|
|
629
|
-
isClosable?: boolean;
|
|
630
|
-
title?: string;
|
|
631
|
-
};
|
|
632
|
-
export interface LayoutRow extends LayoutItemConfig {
|
|
633
|
-
type: 'row';
|
|
634
|
-
}
|
|
635
|
-
export interface LayoutColumn extends LayoutItemConfig {
|
|
636
|
-
type: 'column';
|
|
637
|
-
}
|
|
638
|
-
export interface LayoutComponent extends LayoutItemConfig {
|
|
639
|
-
componentName: 'view';
|
|
640
|
-
componentState?: Partial<ViewCreationOptions>;
|
|
641
|
-
}
|
|
642
|
-
export declare type LayoutOptions = {
|
|
643
|
-
settings?: {
|
|
644
|
-
popoutWholeStack?: boolean;
|
|
645
|
-
constrainDragToContainer?: boolean;
|
|
646
|
-
showPopoutIcon?: boolean;
|
|
647
|
-
showMaximiseIcon?: boolean;
|
|
648
|
-
showCloseIcon?: boolean;
|
|
649
|
-
constrainDragToHeaders?: boolean;
|
|
650
|
-
hasHeaders?: boolean;
|
|
651
|
-
reorderEnabled?: boolean;
|
|
652
|
-
preventDragOut?: boolean;
|
|
653
|
-
preventDragIn?: boolean;
|
|
654
|
-
};
|
|
655
|
-
content?: LayoutContent;
|
|
656
|
-
dimensions?: {
|
|
657
|
-
borderWidth?: number;
|
|
658
|
-
minItemHeight?: number;
|
|
659
|
-
minItemWidth?: number;
|
|
660
|
-
headerHeight?: number;
|
|
661
|
-
};
|
|
662
|
-
};
|
|
663
|
-
export declare type OverrideCallback<T extends any = PlatformProvider, U extends T = T> = (arg: Constructor<T>) => U | Promise<U>;
|
|
664
|
-
export declare type Constructor<T = {}> = new () => T;
|
|
665
|
-
export declare type HostContextChangedReasons = 'updated' | 'reparented';
|
|
666
|
-
export declare type WindowCreationReason = 'tearout' | 'create-view-without-target' | 'api-call' | 'app-creation' | 'restore' | 'apply-snapshot';
|
|
667
|
-
export declare type PlatformProvider = {
|
|
668
|
-
/**
|
|
669
|
-
* Handles requests to create a window in the current platform.
|
|
670
|
-
* @param { WindowOption } payload Window options for the window to be created.
|
|
671
|
-
* @param { Identity } [identity] If {@link Platform#createWindow Platform.createWindow} was called, the identity of the caller will be here.
|
|
672
|
-
* If `createWindow` was called as part of applying a snapshot or creating a view without a target window, `identity` will be undefined.
|
|
673
|
-
*/
|
|
674
|
-
createWindow(options: PlatformWindowCreationOptions, identity?: Identity): Promise<_Window>;
|
|
675
|
-
/**
|
|
676
|
-
* Gets the current state of windows and their views and returns a snapshot object containing that info.
|
|
677
|
-
* @param { undefined } payload Undefined unless you've defined a custom `getSnapshot` protocol.
|
|
678
|
-
* @param { Identity } identity Identity of the entity that called {@link Platform#getSnapshot Platform.getSnapshot}.
|
|
679
|
-
* @return { Promise<Snapshot> } Snapshot of current platform state.
|
|
680
|
-
*/
|
|
681
|
-
getSnapshot(payload: undefined, identity: Identity): Promise<Snapshot>;
|
|
682
|
-
/**
|
|
683
|
-
* **NOTE**: Internal use only. It is not recommended to manage the state of individual views.
|
|
684
|
-
* 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.
|
|
685
|
-
* @param { Identity } payload Identity of the view.
|
|
686
|
-
* @return { Promise<ViewState> }
|
|
687
|
-
* @internal
|
|
688
|
-
* @experimental
|
|
689
|
-
*/
|
|
690
|
-
getViewSnapshot(payload: {
|
|
691
|
-
viewIdentity: Identity;
|
|
692
|
-
}): Promise<ViewState>;
|
|
693
|
-
/**
|
|
694
|
-
* Called when a snapshot is being applied and some windows in that snapshot would be fully or partially off-screen.
|
|
695
|
-
* Returns an array of windows with modified positions, such that any off-screen windows are positioned in the top left
|
|
696
|
-
* corner of the main monitor.
|
|
697
|
-
* @param { Snapshot } snapshot The snapshot to be applied.
|
|
698
|
-
* @param { WindowOptions[] } outOfBoundsWindows An array of WindowOptions for any windows that would be off-screen.
|
|
699
|
-
* @return { Promise<WindowOptions[]> } An array of WindowOptions with their position modified to fit on screen.
|
|
700
|
-
*/
|
|
701
|
-
positionOutOfBoundsWindows(snapshot: Snapshot, outOfBoundsWindows: WindowCreationOptions[]): Promise<WindowCreationOptions[]>;
|
|
702
|
-
/**
|
|
703
|
-
* Handles requests to apply a snapshot to the current Platform.
|
|
704
|
-
* @param { ApplySnapshotPayload } payload Payload containing the snapshot to be applied, as well as any options.
|
|
705
|
-
* @param { Identity } [identity] Identity of the entity that called {@link Platform#applySnapshot Platform.applySnapshot}.
|
|
706
|
-
* Undefined if called internally (e.g. when opening the initial snapshot).
|
|
707
|
-
* @return { Promise<void> }
|
|
708
|
-
*/
|
|
709
|
-
applySnapshot(payload: ApplySnapshotPayload, identity?: Identity): Promise<void>;
|
|
710
|
-
/**
|
|
711
|
-
* Closes the current Platform and all child windows and views.
|
|
712
|
-
* @param { undefined } payload Undefined unless you have implemented a custom quite protocol.
|
|
713
|
-
* @param { Identity } identity Identity of the entity that called {@link Platform#quit Platform.quit}.
|
|
714
|
-
* @return { Promise<void> }
|
|
715
|
-
*/
|
|
716
|
-
quit(payload: undefined, identity: Identity): Promise<void>;
|
|
717
|
-
/**
|
|
718
|
-
* Closes a view
|
|
719
|
-
* @param { CloseViewPayload } payload Specifies the `target` view to be closed.
|
|
720
|
-
* @param { Identity } identity Identity of the entity that called {@link Platform#closeView Platform.closeView}.
|
|
721
|
-
*/
|
|
722
|
-
closeView(payload: CloseViewPayload, identity?: Identity): Promise<any>;
|
|
723
|
-
/**
|
|
724
|
-
* Creates a new view and attaches it to a specified target window.
|
|
725
|
-
* @param { CreateViewPayload } payload Creation options for the new view.
|
|
726
|
-
* @param { Identity } identity Identity of the entity that called {@link Platform#createView Platform.createView}.
|
|
727
|
-
* @return { Promise<void> }
|
|
728
|
-
*/
|
|
729
|
-
createView(payload: CreateViewPayload, identity: Identity): Promise<View>;
|
|
730
|
-
/** Handles requests to fetch manifests in the current platform.
|
|
731
|
-
* @param { FetchManifestPayload } payload Payload containing the manifestUrl to be fetched.
|
|
732
|
-
* @param { Identity } callerIdentity If {@link Platform#fetchManifest Platform.fetchManifest}
|
|
733
|
-
* was called, the identity of the caller will be here.
|
|
734
|
-
* If `fetchManifest` was called internally, `callerIdentity` will be the provider's identity.
|
|
735
|
-
*/
|
|
736
|
-
fetchManifest(payload: FetchManifestPayload, callerIdentity: Identity): Promise<any>;
|
|
737
|
-
/**
|
|
738
|
-
* Replaces a Platform window's layout with a new layout. Any views that were in the old layout but not the new layout will be destroyed.
|
|
739
|
-
* @param { ReplaceLayoutPayload } payload Contains the `target` window and an `opts` object with a `layout` property to apply.
|
|
740
|
-
* @param { Identity } [identity] Identity of the entity that called {@link Platform#replaceLayout Platform.replaceLayout}.
|
|
741
|
-
* Undefined if `replaceLayout` is called internally (e.g. while applying a snapshot).
|
|
742
|
-
* @return { Promise<void> }
|
|
743
|
-
*/
|
|
744
|
-
replaceLayout(payload: ReplaceLayoutPayload, identity?: Identity): Promise<void>;
|
|
745
|
-
replaceView(payload: ReplaceViewPayload, identity?: Identity): Promise<void>;
|
|
746
|
-
launchIntoPlatform(payload: LaunchIntoPlatformPayload): Promise<void>;
|
|
747
|
-
/**
|
|
748
|
-
* Handles requests to set a window's context. `target` may be a window or a view.
|
|
749
|
-
* If it is a window, that window's `customContext` will be updated.
|
|
750
|
-
* If it is a view, the `customContext` of that view's current host window will be updated.
|
|
751
|
-
* @param { SetWindowContextPayload } payload Object containing the requested `context` update,
|
|
752
|
-
* the `target`'s identity, and the target's `entityType`.
|
|
753
|
-
* @param { Identity } [identity] Identity of the entity that called {@link Platform#setWindowContext Platform.setWindowContext}.
|
|
754
|
-
* Undefined if `setWindowContext` is called internally (e.g. while applying a snapshot).
|
|
755
|
-
* @return { Promise<any> } The new context.
|
|
756
|
-
*/
|
|
757
|
-
setWindowContext(payload: SetWindowContextPayload, identity?: Identity): Promise<any>;
|
|
758
|
-
/**
|
|
759
|
-
* Handles requests to get a window's context. `target` may be a window or a view.
|
|
760
|
-
* If it is a window, that window's `customContext` will be returned.
|
|
761
|
-
* If it is a view, the `customContext` of that view's current host window will be returned.
|
|
762
|
-
* @param { GetWindowContextPayload } payload Object containing the requested `context` update,
|
|
763
|
-
* the `target`'s identity, and the target's `entityType`.
|
|
764
|
-
* @param { Identity } [identity] Identity of the entity that called {@link Platform#getWindowContext Platform.getWindowContext}.
|
|
765
|
-
* Undefined when `getWindowContext` is called internally
|
|
766
|
-
* (e.g. when getting a window's context for the purpose of raising a "host-context-changed" event on a reparented view).
|
|
767
|
-
* @return { Promise<any> } The new context.
|
|
768
|
-
*/
|
|
769
|
-
getWindowContext(payload: GetWindowContextPayload, identity?: Identity): Promise<any>;
|
|
770
|
-
/**
|
|
771
|
-
* Called when a window's `customContext` is updated. Responsible for raising the `host-context-updated` event on that window's child views.
|
|
772
|
-
* @param { WindowOptionsChangedEvent<'window', 'options-changed'> } payload The event payload for the window whose context has changed.
|
|
773
|
-
* The new context will be contained as `payload.diff.customContext.newVal`.
|
|
774
|
-
* @return { Promise<HostContextChangedPayload> } The event that it raised.
|
|
775
|
-
*/
|
|
776
|
-
onWindowContextUpdated(payload: WindowOptionsChangedEvent<'window', 'options-changed'>): Promise<HostContextChangedPayload | undefined>;
|
|
777
|
-
/**
|
|
778
|
-
* Closes a Window.
|
|
779
|
-
* By default it will fire any before unload handler set by a View in the Window.
|
|
780
|
-
* This can be disabled by setting skipBeforeUnload in the options object of the payload.
|
|
781
|
-
* This method is called by {@link Platform#closeWindow Platform.closeWindow}.
|
|
782
|
-
* @param {CloseWindowPayload} payload Object that contains the Window Identity and related options.
|
|
783
|
-
* @param {Identity} callerIdentity
|
|
784
|
-
* @returns {Promise<void>}
|
|
785
|
-
*/
|
|
786
|
-
closeWindow(payload: CloseWindowPayload, callerIdentity: Identity): Promise<void>;
|
|
787
|
-
/**
|
|
788
|
-
* Gets all the Views attached to a Window that should close along with it. This is meant to be overridable
|
|
789
|
-
* in the case where you want to return other Views that may not be attached to the Window that is closing.
|
|
790
|
-
* @param winId Identity of the Window that is closing
|
|
791
|
-
* @returns { Promise<View> }
|
|
792
|
-
*/
|
|
793
|
-
getViewsForWindowClose(windowId: Identity): Promise<View[]>;
|
|
794
|
-
/**
|
|
795
|
-
* It takes in an array of Views and returns an object specifying which of them are trying to prevent an unload and which are not.
|
|
796
|
-
* @param {View[]} views Array of Views
|
|
797
|
-
* @returns { Promise<ViewStatuses> }
|
|
798
|
-
*/
|
|
799
|
-
checkViewsForPreventUnload(views: View[]): Promise<ViewStatuses>;
|
|
800
|
-
/**
|
|
801
|
-
* Handle the decision of whether a Window or specific View should close when trying to prevent an unload. This is meant to be overridden.
|
|
802
|
-
* Called in {@link PlatformProvider#closeWindow PlatformProvider.closeWindow}.
|
|
803
|
-
* Normally you would use this method to show a dialog indicating that there are Views that are trying to prevent an unload.
|
|
804
|
-
* By default it will always return all Views passed into it as meaning to close.
|
|
805
|
-
* @param {ViewsPreventingUnloadPayload} payload
|
|
806
|
-
* @tutorial PlatformProvider.getUserDecisionForBeforeUnload
|
|
807
|
-
* @returns {Promise<BeforeUnloadUserDecision>}
|
|
808
|
-
*/
|
|
809
|
-
getUserDecisionForBeforeUnload(payload: ViewsPreventingUnloadPayload): Promise<BeforeUnloadUserDecision>;
|
|
810
|
-
/**
|
|
811
|
-
* Handles the closing of a Window and/or its Views. Called in {@link PlatformProvider#closeWindow PlatformProvider.closeWindow}.
|
|
812
|
-
* The return of {@link PlatformProvider#getUserDecisionForBeforeUnload PlatformProvider.getUserDecisionForBeforeUnload} is passed into this method.
|
|
813
|
-
* @param {Identity} winId Identity of the Window
|
|
814
|
-
* @param {BeforeUnloadUserDecision} userDecision Decision object
|
|
815
|
-
* @returns {Promise<void>}
|
|
816
|
-
*/
|
|
817
|
-
handleViewsAndWindowClose(windowId: Identity, userDecision: BeforeUnloadUserDecision): Promise<void>;
|
|
818
|
-
};
|
|
819
|
-
export declare type InitPlatformOptions = {
|
|
820
|
-
overrideCallback?: OverrideCallback<PlatformProvider>;
|
|
821
|
-
interopOverride?: OverrideCallback<InteropBroker>;
|
|
822
|
-
};
|
|
823
|
-
export declare type ProcessDetails = {
|
|
824
|
-
cpuUsage: number;
|
|
825
|
-
nonPagedPoolUsage: number;
|
|
826
|
-
pageFaultCount: number;
|
|
827
|
-
pagedPoolUsage: number;
|
|
828
|
-
pagefileUsage: number;
|
|
829
|
-
peakNonPagedPoolUsage: number;
|
|
830
|
-
peakPagedPoolUsage: number;
|
|
831
|
-
peakPagefileUsage: number;
|
|
832
|
-
peakWorkingSetSize: number;
|
|
833
|
-
workingSetSize: number;
|
|
834
|
-
privateSetSize: number;
|
|
835
|
-
pid: number;
|
|
836
|
-
};
|
|
837
|
-
export declare type FrameProcessDetails = ProcessDetails & {
|
|
838
|
-
url: string;
|
|
839
|
-
entityType: string;
|
|
840
|
-
};
|
|
841
|
-
export declare type EntityProcessDetails = FrameProcessDetails & {
|
|
842
|
-
name: string;
|
|
843
|
-
uuid: string;
|
|
844
|
-
iframes: FrameProcessDetails[];
|
|
845
|
-
};
|
|
846
|
-
export declare type AppProcessInfo = {
|
|
847
|
-
uuid: string;
|
|
848
|
-
entities: EntityProcessDetails[];
|
|
849
|
-
};
|
|
850
|
-
export declare type NonAppProcessDetails = ProcessDetails & {
|
|
851
|
-
name: string;
|
|
852
|
-
};
|
|
853
|
-
export declare type SystemProcessInfo = {
|
|
854
|
-
apps: AppProcessInfo[];
|
|
855
|
-
browserProcess: NonAppProcessDetails;
|
|
856
|
-
nonApps: NonAppProcessDetails[];
|
|
857
|
-
};
|
|
858
|
-
export declare type ClearCacheOption = {
|
|
859
|
-
appcache?: boolean;
|
|
860
|
-
cache?: boolean;
|
|
861
|
-
cookies?: boolean;
|
|
862
|
-
localStorage?: boolean;
|
|
863
|
-
};
|
|
864
|
-
export declare type CookieInfo = {
|
|
865
|
-
name: string;
|
|
866
|
-
domain: string;
|
|
867
|
-
path: string;
|
|
868
|
-
};
|
|
869
|
-
export declare type CookieOption = {
|
|
870
|
-
name: string;
|
|
871
|
-
};
|
|
872
|
-
export declare type CrashReporterOptions = {
|
|
873
|
-
diagnosticsMode: boolean;
|
|
874
|
-
};
|
|
875
|
-
export declare type CrashReporterState = CrashReporterOptions & {
|
|
876
|
-
isRunning: boolean;
|
|
877
|
-
diagnosticMode: boolean;
|
|
878
|
-
};
|
|
879
|
-
export declare type Time = {
|
|
880
|
-
user: number;
|
|
881
|
-
nice: number;
|
|
882
|
-
sys: number;
|
|
883
|
-
idle: number;
|
|
884
|
-
irq: number;
|
|
885
|
-
};
|
|
886
|
-
export declare type CpuInfo = {
|
|
887
|
-
model: string;
|
|
888
|
-
speed: number;
|
|
889
|
-
times: Time;
|
|
890
|
-
};
|
|
891
|
-
export declare type GpuInfo = {
|
|
892
|
-
name: string;
|
|
893
|
-
};
|
|
894
|
-
export declare type HostSpecs = {
|
|
895
|
-
aeroGlassEnabled?: boolean;
|
|
896
|
-
arch: string;
|
|
897
|
-
cpus: CpuInfo[];
|
|
898
|
-
gpu: GpuInfo;
|
|
899
|
-
memory: number;
|
|
900
|
-
name: string;
|
|
901
|
-
screenSaver?: boolean;
|
|
902
|
-
};
|
|
903
|
-
export declare type PrinterInfo = {
|
|
904
|
-
name: string;
|
|
905
|
-
description: string;
|
|
906
|
-
status: number;
|
|
907
|
-
isDefault: boolean;
|
|
908
|
-
};
|
|
909
|
-
export declare type Dpi = {
|
|
910
|
-
horizontal?: number;
|
|
911
|
-
vertical?: number;
|
|
912
|
-
};
|
|
913
|
-
export declare type Margins = {
|
|
914
|
-
marginType?: 'default' | 'none' | 'printableArea' | 'custom';
|
|
915
|
-
top?: number;
|
|
916
|
-
bottom?: number;
|
|
917
|
-
left?: number;
|
|
918
|
-
right?: number;
|
|
919
|
-
};
|
|
920
|
-
export declare type PrintOptions = {
|
|
921
|
-
silent?: boolean;
|
|
922
|
-
printBackground?: boolean;
|
|
923
|
-
deviceName?: string;
|
|
924
|
-
color?: boolean;
|
|
925
|
-
margins?: Margins;
|
|
926
|
-
landscape?: boolean;
|
|
927
|
-
scaleFactor?: number;
|
|
928
|
-
pagesPerSheet?: number;
|
|
929
|
-
collate?: boolean;
|
|
930
|
-
copies?: number;
|
|
931
|
-
pageRanges?: Record<string, number>;
|
|
932
|
-
duplexMode?: 'simplex' | 'shortEdge' | 'longEdge';
|
|
933
|
-
dpi?: Dpi;
|
|
934
|
-
};
|
|
935
|
-
export declare type WriteRequestType = {
|
|
936
|
-
data: string;
|
|
937
|
-
type?: string;
|
|
938
|
-
};
|
|
939
|
-
export declare type WriteAnyRequestType = {
|
|
940
|
-
data: {
|
|
941
|
-
text?: string;
|
|
942
|
-
html?: string;
|
|
943
|
-
rtf?: string;
|
|
944
|
-
};
|
|
945
|
-
type?: string;
|
|
946
|
-
};
|
|
947
|
-
export declare type SubscriptionOptions = {
|
|
948
|
-
timestamp?: number;
|
|
949
|
-
};
|
|
950
|
-
export declare type SharedWorkerInfo = {
|
|
951
|
-
id: string;
|
|
952
|
-
url: string;
|
|
953
|
-
};
|
|
954
|
-
export declare type ServiceIdentifier = {
|
|
955
|
-
name: string;
|
|
956
|
-
};
|
|
957
|
-
export declare type ServiceConfiguration = {
|
|
958
|
-
config: object;
|
|
959
|
-
name: string;
|
|
960
|
-
};
|
|
961
|
-
export declare type RVMInfo = {
|
|
962
|
-
'action': string;
|
|
963
|
-
'appLogDirectory': string;
|
|
964
|
-
'path': string;
|
|
965
|
-
'start-time': string;
|
|
966
|
-
'version': string;
|
|
967
|
-
'working-dir': string;
|
|
968
|
-
};
|
|
969
|
-
export declare type AppVersionProgress = {
|
|
970
|
-
manifest: string | null;
|
|
971
|
-
srcManifest: string;
|
|
972
|
-
};
|
|
973
|
-
export declare type AppVersionError = {
|
|
974
|
-
error: string;
|
|
975
|
-
srcManifest: string;
|
|
976
|
-
};
|
|
977
|
-
export declare type AppVersionRuntimeInfo = {
|
|
978
|
-
version: string | null;
|
|
979
|
-
exists: boolean | null;
|
|
980
|
-
writeAccess: boolean | null;
|
|
981
|
-
reachable: boolean | null;
|
|
982
|
-
healthCheck: boolean | null;
|
|
983
|
-
error: string | null;
|
|
984
|
-
};
|
|
985
|
-
export declare type AppVersionProgressEvent = {
|
|
986
|
-
type: 'app-version-progress';
|
|
987
|
-
} & AppVersionProgress;
|
|
988
|
-
export declare type AppVersionErrorEvent = {
|
|
989
|
-
type: 'app-version-error';
|
|
990
|
-
} & AppVersionError;
|
|
991
|
-
export declare type AppVersionCompleteEvent = {
|
|
992
|
-
type: 'app-version-complete';
|
|
993
|
-
} & AppVersionProgress;
|
|
994
|
-
export declare type AppVersionRuntimeStatusEvent = {
|
|
995
|
-
type: 'runtime-status';
|
|
996
|
-
} & AppVersionRuntimeInfo;
|
|
997
|
-
export declare type AppVersionEvents = AppVersionProgressEvent | AppVersionRuntimeStatusEvent | AppVersionCompleteEvent | AppVersionErrorEvent;
|
|
998
|
-
export declare type AppVersionEventNames = AppVersionEvents['type'];
|
|
999
|
-
export declare type LaunchEmitter = import('./api/events/typedEventEmitter').TypedEventEmitter<AppVersionEvents>;
|
|
1000
|
-
export declare type RvmLaunchOptions = {
|
|
1001
|
-
noUi?: boolean;
|
|
1002
|
-
userAppConfigArgs?: object;
|
|
1003
|
-
timeToLive?: number;
|
|
1004
|
-
subscribe?: (launch: LaunchEmitter) => void;
|
|
1005
|
-
};
|
|
1006
|
-
export declare type ShortCutConfig = {
|
|
1007
|
-
desktop?: boolean;
|
|
1008
|
-
startMenu?: boolean;
|
|
1009
|
-
systemStartup?: boolean;
|
|
1010
|
-
};
|
|
1011
|
-
export declare type TerminateExternalRequestType = {
|
|
1012
|
-
uuid: string;
|
|
1013
|
-
timeout: number;
|
|
1014
|
-
killTree: boolean;
|
|
1015
|
-
};
|
|
1016
|
-
export declare type TrayInfo = {
|
|
1017
|
-
bounds: Rectangle;
|
|
1018
|
-
monitorInfo: MonitorInfo;
|
|
1019
|
-
x: number;
|
|
1020
|
-
y: number;
|
|
1021
|
-
};
|
|
1022
|
-
export declare type Transition = {
|
|
1023
|
-
opacity?: Opacity;
|
|
1024
|
-
position?: Position;
|
|
1025
|
-
size?: Size;
|
|
1026
|
-
};
|
|
1027
|
-
export declare type Size = TransitionBase & {
|
|
1028
|
-
width: number;
|
|
1029
|
-
height: number;
|
|
1030
|
-
};
|
|
1031
|
-
export declare type Opacity = TransitionBase & {
|
|
1032
|
-
opacity: number;
|
|
1033
|
-
};
|
|
1034
|
-
export declare type TransitionBase = {
|
|
1035
|
-
duration: number;
|
|
1036
|
-
relative?: boolean;
|
|
1037
|
-
};
|
|
1038
|
-
export declare type Position = TransitionBase & {
|
|
1039
|
-
left: number;
|
|
1040
|
-
top: number;
|
|
1041
|
-
};
|
|
1042
|
-
export declare type AnchorType = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
|
|
1043
|
-
export declare type TransitionOptions = {
|
|
1044
|
-
interrupt: boolean;
|
|
1045
|
-
tween?: tween;
|
|
1046
|
-
};
|
|
1047
|
-
export declare 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';
|
|
1048
|
-
export declare type FindInPageOptions = {
|
|
1049
|
-
forward?: boolean;
|
|
1050
|
-
findNext?: boolean;
|
|
1051
|
-
matchCase?: boolean;
|
|
1052
|
-
wordStart?: boolean;
|
|
1053
|
-
medialCapitalAsWordStart?: boolean;
|
|
1054
|
-
};
|
|
1055
|
-
export declare type FrameInfo = {
|
|
1056
|
-
name: string;
|
|
1057
|
-
uuid: string;
|
|
1058
|
-
entityType: EntityType;
|
|
1059
|
-
parent: Identity;
|
|
1060
|
-
};
|
|
1061
|
-
export declare type ExternalApplicationInfo = {
|
|
1062
|
-
parent: Identity;
|
|
1063
|
-
};
|
|
1064
|
-
export declare type ExternalConnection = {
|
|
1065
|
-
token: string;
|
|
1066
|
-
uuid: string;
|
|
1067
|
-
};
|
|
1068
|
-
export declare type ExternalProcessRequestType = {
|
|
1069
|
-
path?: string;
|
|
1070
|
-
alias?: string;
|
|
1071
|
-
arguments?: string;
|
|
1072
|
-
listener?: LaunchExternalProcessListener;
|
|
1073
|
-
lifetime?: string;
|
|
1074
|
-
certificate?: CertificationInfo;
|
|
1075
|
-
uuid?: string;
|
|
1076
|
-
initialWindowState?: string;
|
|
1077
|
-
cwd?: string;
|
|
1078
|
-
};
|
|
1079
|
-
export declare type CertificationInfo = {
|
|
1080
|
-
serial?: string;
|
|
1081
|
-
subject?: string;
|
|
1082
|
-
publickey?: string;
|
|
1083
|
-
thumbprint?: string;
|
|
1084
|
-
trusted?: boolean;
|
|
1085
|
-
};
|
|
1086
|
-
export declare type ExitCode = {
|
|
1087
|
-
topic: string;
|
|
1088
|
-
uuid: string;
|
|
1089
|
-
exitCode: number;
|
|
1090
|
-
};
|
|
1091
|
-
export declare type LaunchExternalProcessListener = {
|
|
1092
|
-
(code: ExitCode): void;
|
|
1093
|
-
};
|
|
1094
|
-
export declare type ExternalProcessInfo = {
|
|
1095
|
-
pid: number;
|
|
1096
|
-
listener?: LaunchExternalProcessListener;
|
|
1097
|
-
};
|
|
1098
|
-
export declare type AppAssetInfo = {
|
|
1099
|
-
src: string;
|
|
1100
|
-
alias: string;
|
|
1101
|
-
version: string;
|
|
1102
|
-
target?: string;
|
|
1103
|
-
args?: string;
|
|
1104
|
-
mandatory?: boolean;
|
|
1105
|
-
};
|
|
1106
|
-
export declare type RuntimeDownloadOptions = {
|
|
1107
|
-
version: string;
|
|
1108
|
-
};
|
|
1109
|
-
export declare type AppAssetRequest = {
|
|
1110
|
-
alias: string;
|
|
1111
|
-
};
|
|
1112
|
-
export declare type RuntimeDownloadProgress = {
|
|
1113
|
-
downloadedBytes: number;
|
|
1114
|
-
totalBytes: number;
|
|
1115
|
-
};
|
|
1116
|
-
export declare type CertifiedAppInfo = {
|
|
1117
|
-
isRunning: boolean;
|
|
1118
|
-
isOptedIntoCertfiedApp?: boolean;
|
|
1119
|
-
isCertified?: boolean;
|
|
1120
|
-
isSSLCertified?: boolean;
|
|
1121
|
-
isPresentInAppDirectory?: boolean;
|
|
1122
|
-
};
|
|
1123
|
-
export declare type JumpListCategory = {
|
|
1124
|
-
name?: string;
|
|
1125
|
-
items: Array<JumpListTask | JumpListSeparator>;
|
|
1126
|
-
};
|
|
1127
|
-
export declare type JumpListItem = JumpListTask | JumpListSeparator;
|
|
1128
|
-
export declare type JumpListTask = {
|
|
1129
|
-
type: 'task';
|
|
1130
|
-
title: string;
|
|
1131
|
-
description: string;
|
|
1132
|
-
deepLink: string;
|
|
1133
|
-
iconPath?: string;
|
|
1134
|
-
iconIndex?: number;
|
|
1135
|
-
};
|
|
1136
|
-
export declare type JumpListSeparator = {
|
|
1137
|
-
type: 'separator';
|
|
1138
|
-
};
|
|
1139
|
-
export declare type ApplicationInfo = {
|
|
1140
|
-
initialOptions: ApplicationCreationOptions;
|
|
1141
|
-
launchMode: string;
|
|
1142
|
-
manifest: Manifest & {
|
|
1143
|
-
[key: string]: any;
|
|
1144
|
-
};
|
|
1145
|
-
manifestUrl: string;
|
|
1146
|
-
parentUuid?: string;
|
|
1147
|
-
runtime: {
|
|
1148
|
-
version: string;
|
|
1149
|
-
};
|
|
1150
|
-
};
|
|
1151
|
-
export declare type ManifestInfo = {
|
|
1152
|
-
uuid: string;
|
|
1153
|
-
manifestUrl: string;
|
|
1154
|
-
};
|
|
1155
|
-
export declare type ClickedMenuResult = {
|
|
1156
|
-
result: 'clicked';
|
|
1157
|
-
data: any;
|
|
1158
|
-
};
|
|
1159
|
-
export declare type ClosedMenuResult = {
|
|
1160
|
-
result: 'closed';
|
|
1161
|
-
};
|
|
1162
|
-
export declare type MenuResult = ClickedMenuResult | ClosedMenuResult;
|
|
1163
|
-
export declare type ShowPopupMenuOptions = {
|
|
1164
|
-
template: MenuItemTemplate[];
|
|
1165
|
-
x?: number;
|
|
1166
|
-
y?: number;
|
|
1167
|
-
};
|
|
1168
|
-
export declare type MenuItemTemplate = {
|
|
1169
|
-
/**
|
|
1170
|
-
* Can be `normal`, `separator`, `submenu`, or `checkbox`.
|
|
1171
|
-
* Defaults to 'normal' unless a 'submenu' key exists
|
|
1172
|
-
*/
|
|
1173
|
-
type?: 'normal' | 'separator' | 'submenu' | 'checkbox';
|
|
1174
|
-
role?: 'cut' | 'copy' | 'paste' | 'toggleDevTools' | 'reload';
|
|
1175
|
-
label?: string;
|
|
1176
|
-
/**
|
|
1177
|
-
* If false, the menu item will be greyed out and unclickable.
|
|
1178
|
-
*/
|
|
1179
|
-
enabled?: boolean;
|
|
1180
|
-
/**
|
|
1181
|
-
* If false, the menu item will be entirely hidden.
|
|
1182
|
-
*/
|
|
1183
|
-
visible?: boolean;
|
|
1184
|
-
/**
|
|
1185
|
-
* Should only be specified for `checkbox` type menu items.
|
|
1186
|
-
*/
|
|
1187
|
-
checked?: boolean;
|
|
1188
|
-
/**
|
|
1189
|
-
* Should be specified for `submenu` type menu items. If `submenu` is specified,
|
|
1190
|
-
* the `type: 'submenu'` can be omitted.
|
|
1191
|
-
*/
|
|
1192
|
-
submenu?: MenuItemTemplate[];
|
|
1193
|
-
/**
|
|
1194
|
-
* Data to be returned if the user selects the element. Must be serializable
|
|
1195
|
-
*/
|
|
1196
|
-
data?: any;
|
|
1197
|
-
/**
|
|
1198
|
-
* Image Data URI with image dimensions inferred from the encoded string
|
|
1199
|
-
*/
|
|
1200
|
-
icon?: string;
|
|
1201
|
-
};
|
|
1202
|
-
export declare type NativeWindowIntegrationProviderAuthorization = {
|
|
1203
|
-
authorizedUuid: string;
|
|
1204
|
-
};
|
|
1205
|
-
export declare type RuntimeInfo = {
|
|
1206
|
-
architecture: string;
|
|
1207
|
-
manifestUrl: string;
|
|
1208
|
-
port: number;
|
|
1209
|
-
securityRealm?: string;
|
|
1210
|
-
version: string;
|
|
1211
|
-
args: object;
|
|
1212
|
-
chromeVersion: string;
|
|
1213
|
-
electronVersion: string;
|
|
1214
|
-
devtoolsPort?: number;
|
|
1215
|
-
};
|
|
1216
|
-
export declare type DefaultDomainSettings = {
|
|
1217
|
-
rules: DefaultDomainSettingsRule[];
|
|
1218
|
-
};
|
|
1219
|
-
export declare type DefaultDomainSettingsRule = {
|
|
1220
|
-
match: string[];
|
|
1221
|
-
options: {
|
|
1222
|
-
downloadSettings: FileDownloadSettings;
|
|
1223
|
-
};
|
|
1224
|
-
};
|
|
1225
|
-
export declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt' | 'block';
|
|
1226
|
-
export declare type FileDownloadSettings = {
|
|
1227
|
-
rules: DownloadRule[];
|
|
1228
|
-
};
|
|
1229
|
-
export declare type DownloadRule = {
|
|
1230
|
-
behavior: FileDownloadBehaviorNames;
|
|
1231
|
-
match: string[];
|
|
1232
|
-
};
|
|
1233
|
-
export declare type ContextHandler = (context: Context) => void;
|
|
1234
|
-
export declare type Intent<MetadataType = IntentMetadata> = {
|
|
1235
|
-
name: string;
|
|
1236
|
-
context: Context;
|
|
1237
|
-
metadata?: MetadataType;
|
|
1238
|
-
};
|
|
1239
|
-
export declare type IntentMetadata<TargetType = any> = {
|
|
1240
|
-
target?: TargetType;
|
|
1241
|
-
resultType?: string;
|
|
1242
|
-
intentResolutionResultId?: string;
|
|
1243
|
-
};
|
|
1244
|
-
export declare type IntentHandler = (intent: Intent) => void;
|
|
1245
|
-
export declare type ContentCreationBehaviorNames = 'window' | 'view' | 'block' | 'browser';
|
|
1246
|
-
declare type MatchPattern = string;
|
|
1247
|
-
export declare type ContentCreationRule<T = ContentCreationBehaviorNames> = {
|
|
1248
|
-
behavior: T;
|
|
1249
|
-
match: MatchPattern[];
|
|
1250
|
-
options?: T extends 'window' ? Partial<WindowOptions> : T extends 'view' ? Partial<ViewOptions> : never;
|
|
1251
|
-
};
|
|
1252
|
-
export declare type ContentCreationOptions = {
|
|
1253
|
-
rules: ContentCreationRule[];
|
|
1254
|
-
};
|
|
1255
|
-
export declare type SnapshotProvider<T> = {
|
|
1256
|
-
getSnapshot: () => Promise<T>;
|
|
1257
|
-
applySnapshot: (snapshot: T) => Promise<void>;
|
|
1258
|
-
};
|
|
1259
|
-
export declare type QueryPermissionResult = {
|
|
1260
|
-
permission: string;
|
|
1261
|
-
state: PermissionState;
|
|
1262
|
-
granted: boolean;
|
|
1263
|
-
rawValue?: unknown;
|
|
1264
|
-
};
|
|
1265
|
-
export declare type SessionContextGroup = {
|
|
1266
|
-
id: string;
|
|
1267
|
-
setContext: (context: Context) => Promise<void>;
|
|
1268
|
-
getCurrentContext: (type?: string) => Promise<Context>;
|
|
1269
|
-
addContextHandler: (handler: ContextHandler, contextType?: string) => Promise<{
|
|
1270
|
-
unsubscribe: () => void;
|
|
1271
|
-
}>;
|
|
1272
|
-
};
|
|
1273
|
-
export type { MessagingProtocols };
|
|
1274
|
-
export declare type ChannelCreateOptions = {
|
|
1275
|
-
protocols?: MessagingProtocols[];
|
|
1276
|
-
};
|
|
1277
|
-
export declare type ChannelConnectOptions = ChannelCreateOptions & {
|
|
1278
|
-
wait?: boolean;
|
|
1279
|
-
payload?: any;
|
|
1280
|
-
};
|
|
1281
|
-
export declare type ContextForIntent<MetadataType = any> = Context & {
|
|
1282
|
-
metadata?: MetadataType;
|
|
1283
|
-
};
|
|
1284
|
-
export declare type InfoForIntentOptions<MetadataType = IntentMetadata> = {
|
|
1285
|
-
name: string;
|
|
1286
|
-
context?: Context;
|
|
1287
|
-
metadata?: MetadataType;
|
|
1288
|
-
};
|
|
1289
|
-
export declare type FindIntentsByContextOptions<MetadataType = IntentMetadata> = {
|
|
1290
|
-
context: Context;
|
|
1291
|
-
metadata?: MetadataType;
|
|
1292
|
-
};
|
|
1293
|
-
export declare type ProviderIdentity = Identity & {
|
|
1294
|
-
channelId: string;
|
|
1295
|
-
channelName: string;
|
|
1296
|
-
};
|
|
1297
|
-
export declare type RegisterUsageData = {
|
|
1298
|
-
data: unknown;
|
|
1299
|
-
type: string;
|
|
1300
|
-
};
|
|
1301
|
-
export interface ViewsPreventingUnloadPayload {
|
|
1302
|
-
windowShouldClose: boolean;
|
|
1303
|
-
windowId: Identity;
|
|
1304
|
-
viewsPreventingUnload: Identity[];
|
|
1305
|
-
viewsNotPreventingUnload: Identity[];
|
|
1306
|
-
closeType: 'view' | 'window';
|
|
1307
|
-
}
|
|
1308
|
-
export interface BeforeUnloadUserDecision {
|
|
1309
|
-
windowShouldClose: boolean;
|
|
1310
|
-
viewsToClose: Identity[];
|
|
1311
|
-
}
|
|
1312
|
-
export interface ViewStatuses {
|
|
1313
|
-
viewsPreventingUnload: Identity[];
|
|
1314
|
-
viewsNotPreventingUnload: Identity[];
|
|
1315
|
-
}
|
|
1316
|
-
export interface CloseWindowPayload {
|
|
1317
|
-
windowId: Identity;
|
|
1318
|
-
options: {
|
|
1319
|
-
skipBeforeUnload?: boolean;
|
|
1320
|
-
};
|
|
1321
|
-
}
|
|
1322
|
-
export declare type ProxyInfo = {
|
|
1323
|
-
config: ProxyConfig;
|
|
1324
|
-
system: ProxySystemInfo;
|
|
1325
|
-
};
|
|
1326
|
-
export declare type ProxyConfig = {
|
|
1327
|
-
proxyAddress: string;
|
|
1328
|
-
proxyPort: number;
|
|
1329
|
-
type: string;
|
|
1330
|
-
};
|
|
1331
|
-
export declare type ProxySystemInfo = {
|
|
1332
|
-
autoConfigUrl: string;
|
|
1333
|
-
bypass: string;
|
|
1334
|
-
enabled: boolean;
|
|
1335
|
-
proxy: string;
|
|
1336
|
-
};
|
|
1337
|
-
export declare type ChannelAction = (payload: unknown, id: ProviderIdentity | ClientIdentity) => unknown;
|
|
1338
|
-
export declare type ChannelMiddleware = (topic: string, payload: unknown, senderIdentity: ProviderIdentity | ClientIdentity) => Promise<unknown> | unknown;
|
|
1339
|
-
export declare type ErrorMiddleware = (topic: string, error: Error, id: ProviderIdentity | ClientIdentity) => unknown;
|
|
1340
|
-
export declare type ApplicationState = {
|
|
1341
|
-
isPlatform: boolean;
|
|
1342
|
-
isRunning: boolean;
|
|
1343
|
-
uuid: string;
|
|
1344
|
-
parentUuid?: string;
|
|
1345
|
-
};
|
|
1346
|
-
export declare type InstalledApps = {
|
|
1347
|
-
[key: string]: InstallationInfo;
|
|
1348
|
-
};
|
|
1349
|
-
export declare type InstallationInfo = {
|
|
1350
|
-
cachedManifest: any;
|
|
1351
|
-
};
|
|
1352
|
-
export declare type GetLogRequestType = {
|
|
1353
|
-
name: string;
|
|
1354
|
-
endFile?: string;
|
|
1355
|
-
sizeLimit?: number;
|
|
1356
|
-
};
|
|
1357
|
-
export declare type LogInfo = {
|
|
1358
|
-
name: string;
|
|
1359
|
-
size: number;
|
|
1360
|
-
date: string;
|
|
1361
|
-
};
|
|
1362
|
-
export declare type SendApplicationLogResponse = {
|
|
1363
|
-
logId: string;
|
|
1364
|
-
};
|
|
1365
|
-
export declare type LogLevel = 'verbose' | 'info' | 'warning' | 'error' | 'fatal';
|
|
1366
|
-
export declare type PermissionState = 'granted' | 'denied' | 'unavailable';
|
|
1367
|
-
export declare type RegistryInfo = {
|
|
1368
|
-
data: any;
|
|
1369
|
-
rootKey: string;
|
|
1370
|
-
subkey: string;
|
|
1371
|
-
type: string;
|
|
1372
|
-
value: string;
|
|
1373
|
-
};
|
|
1374
|
-
export declare type ApplicationType = {
|
|
1375
|
-
type: 'application' | 'external-app';
|
|
1376
|
-
uuid: string;
|
|
1377
|
-
};
|
|
1378
|
-
export declare type WindowInfo = {
|
|
1379
|
-
canNavigateBack: boolean;
|
|
1380
|
-
canNavigateForward: boolean;
|
|
1381
|
-
preloadScripts: Array<any>;
|
|
1382
|
-
title: string;
|
|
1383
|
-
url: string;
|
|
1384
|
-
};
|
|
1385
|
-
export declare type ApplicationWindowInfo = {
|
|
1386
|
-
childWindows: Array<WindowDetail>;
|
|
1387
|
-
mainWindow: WindowDetail;
|
|
1388
|
-
uuid: string;
|
|
1389
|
-
};
|
|
1390
|
-
export declare type WindowDetail = {
|
|
1391
|
-
bottom: number;
|
|
1392
|
-
height: number;
|
|
1393
|
-
isShowing: boolean;
|
|
1394
|
-
left: number;
|
|
1395
|
-
name: string;
|
|
1396
|
-
right: number;
|
|
1397
|
-
state: string;
|
|
1398
|
-
top: number;
|
|
1399
|
-
width: number;
|
|
1400
|
-
};
|
|
1401
|
-
export declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
|
|
1402
|
-
export declare type InitLayoutOptions = {
|
|
1403
|
-
containerId?: string;
|
|
1404
|
-
};
|
|
1405
|
-
export declare type PresetLayoutOptions = {
|
|
1406
|
-
presetType: LayoutPresetType;
|
|
1407
|
-
};
|
|
1408
|
-
export declare type ResultBehavior = 'close' | 'hide' | 'none';
|
|
1409
|
-
export declare type PopupBaseBehavior = 'close' | 'hide';
|
|
1410
|
-
export declare type PopupResultBehavior = 'none' | PopupBaseBehavior;
|
|
1411
|
-
export declare type PopupBlurBehavior = 'modal' | PopupBaseBehavior;
|
|
1412
|
-
declare type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
|
|
1413
|
-
export interface PopupOptions {
|
|
1414
|
-
initialOptions?: Optional<WindowCreationOptions, 'name'>;
|
|
1415
|
-
additionalOptions?: UpdatableWindowOptions;
|
|
1416
|
-
name?: string;
|
|
1417
|
-
url?: string;
|
|
1418
|
-
height?: number;
|
|
1419
|
-
width?: number;
|
|
1420
|
-
x?: number;
|
|
1421
|
-
y?: number;
|
|
1422
|
-
blurBehavior?: PopupBlurBehavior;
|
|
1423
|
-
resultDispatchBehavior?: PopupResultBehavior;
|
|
1424
|
-
hideOnClose?: boolean;
|
|
1425
|
-
focus?: boolean;
|
|
1426
|
-
onPopupReady?: (popupWindow: _Window) => any;
|
|
1427
|
-
onPopupResult?: (payload: PopupResult) => any;
|
|
1428
|
-
}
|
|
1429
|
-
export declare type PopupInteraction = 'clicked' | 'dismissed';
|
|
1430
|
-
export interface PopupResult<T = any> {
|
|
1431
|
-
identity: {
|
|
1432
|
-
name: string;
|
|
1433
|
-
uuid: string;
|
|
1434
|
-
};
|
|
1435
|
-
result: PopupInteraction;
|
|
1436
|
-
data?: T;
|
|
1437
|
-
lastDispatchResult?: PopupResult;
|
|
1438
|
-
}
|
|
1439
|
-
export type { SystemEvents, ApplicationEvents, WindowEvents, ViewEvents, GlobalHotkeyEvents, FrameEvents, PlatformEvents, ExternalApplicationEvents };
|
|
1440
|
-
export declare type ContextMenuOptions = {
|
|
1441
|
-
template?: Array<PrebuiltContextMenuItem>;
|
|
1442
|
-
enabled?: boolean;
|
|
1443
|
-
};
|
|
1444
|
-
export declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | 'copy' | 'paste' | 'selectAll' | 'spellCheck' | 'inspect' | 'reload' | 'navigateForward' | 'navigateBack' | 'print';
|
|
1445
|
-
export declare type InteropBrokerDisconnectionEvent = {
|
|
1446
|
-
type: string;
|
|
1447
|
-
topic: string;
|
|
1448
|
-
brokerName: string;
|
|
1449
|
-
};
|
|
1450
|
-
export declare type InteropClientOnDisconnectionListener = (InteropBrokerDisconnectionEvent: InteropBrokerDisconnectionEvent) => any;
|
|
1451
|
-
export interface InteropActionLoggingOption {
|
|
1452
|
-
enabled: boolean;
|
|
1453
|
-
}
|
|
1454
|
-
export declare type InteropLoggingActions = 'beforeAction' | 'afterAction';
|
|
1455
|
-
export declare type InteropLoggingOptions = Record<InteropLoggingActions, InteropActionLoggingOption>;
|