@openfin/core 41.103.3 → 41.103.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/out/mock-alpha.d.ts +207 -102
- package/out/mock-beta.d.ts +207 -102
- package/out/mock-public.d.ts +207 -102
- package/out/stub.d.ts +207 -102
- package/out/stub.js +179 -327
- package/package.json +41 -36
package/out/mock-alpha.d.ts
CHANGED
|
@@ -88,6 +88,12 @@ declare type AlertRequestedEvent = BaseEvent_5 & {
|
|
|
88
88
|
url: string;
|
|
89
89
|
};
|
|
90
90
|
|
|
91
|
+
declare type AnalyticsOnlyCalls = 'layout-get-stack-by-view' | 'layout-add-view' | 'layout-close-view' | `layout-controller-${string}`;
|
|
92
|
+
|
|
93
|
+
declare type AnalyticsProtocolMap = {
|
|
94
|
+
[k in AnalyticsOnlyCalls]: VoidCall;
|
|
95
|
+
};
|
|
96
|
+
|
|
91
97
|
declare type AnchorType = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
|
|
92
98
|
|
|
93
99
|
declare type AnyStrategy = ChannelStrategy<any>;
|
|
@@ -1676,6 +1682,7 @@ declare type BaseConfig = {
|
|
|
1676
1682
|
devToolsPort?: number;
|
|
1677
1683
|
installerUI?: boolean;
|
|
1678
1684
|
runtime?: RuntimeConfig;
|
|
1685
|
+
apiDiagnostics?: boolean;
|
|
1679
1686
|
appAssets?: [
|
|
1680
1687
|
{
|
|
1681
1688
|
src: string;
|
|
@@ -2774,7 +2781,7 @@ declare class ChannelProvider extends ChannelBase {
|
|
|
2774
2781
|
* a read-only array containing all the identities of connecting clients.
|
|
2775
2782
|
*/
|
|
2776
2783
|
get connections(): OpenFin_2.ClientConnectionPayload[];
|
|
2777
|
-
static handleClientDisconnection(channel: ChannelProvider, payload:
|
|
2784
|
+
static handleClientDisconnection(channel: ChannelProvider, payload: ClientDisconnectionPayload): void;
|
|
2778
2785
|
static setProviderRemoval(provider: ChannelProvider, remove: Function): void;
|
|
2779
2786
|
/* Excluded from this release type: __constructor */
|
|
2780
2787
|
/**
|
|
@@ -3033,6 +3040,11 @@ declare type ClearCacheOption = {
|
|
|
3033
3040
|
* browser data that can be used across sessions
|
|
3034
3041
|
*/
|
|
3035
3042
|
localStorage?: boolean;
|
|
3043
|
+
/**
|
|
3044
|
+
* Clears saved window-state data written for windows that use `saveWindowState`.
|
|
3045
|
+
* After this data is cleared, previously persisted bounds and state (Maximized/Minimized) will not be restored until new state is written again.
|
|
3046
|
+
*/
|
|
3047
|
+
windowState?: boolean;
|
|
3036
3048
|
};
|
|
3037
3049
|
|
|
3038
3050
|
/**
|
|
@@ -3053,6 +3065,10 @@ declare type ClickedMenuResult<Data extends unknown = unknown> = {
|
|
|
3053
3065
|
*/
|
|
3054
3066
|
declare type ClientConnectionPayload = ClientIdentity & ClientInfo;
|
|
3055
3067
|
|
|
3068
|
+
declare type ClientDisconnectionPayload = OpenFin_2.Identity & {
|
|
3069
|
+
endpointId?: string;
|
|
3070
|
+
};
|
|
3071
|
+
|
|
3056
3072
|
/**
|
|
3057
3073
|
* Identity of a channel client. Includes endpointId to differentiate between different connections for an entity.
|
|
3058
3074
|
* @interface
|
|
@@ -3258,6 +3274,7 @@ declare type ClipboardApiPermissions = {
|
|
|
3258
3274
|
writeRtf: boolean;
|
|
3259
3275
|
readRtf: boolean;
|
|
3260
3276
|
write: boolean;
|
|
3277
|
+
setClipboard: boolean;
|
|
3261
3278
|
};
|
|
3262
3279
|
|
|
3263
3280
|
/**
|
|
@@ -4773,20 +4790,11 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
|
|
|
4773
4790
|
eventNames: () => (string | symbol)[];
|
|
4774
4791
|
/* Excluded from this release type: emit */
|
|
4775
4792
|
private hasEmitter;
|
|
4776
|
-
/**
|
|
4777
|
-
* Cleans up after removal of a listener, e.g. deleting any lingering deregistration handlers for a
|
|
4778
|
-
* `once` subscription.
|
|
4779
|
-
*
|
|
4780
|
-
* @remarks Implementing this as a `removeListener` handler ensures that direct removal of a listener
|
|
4781
|
-
* on the base emitter will not leak additional core handlers. We could do this in the forwarding method,
|
|
4782
|
-
* which would involve less "magic," but would be more-vulnerable to accidental re-introduction of a leak.
|
|
4783
|
-
*/
|
|
4784
|
-
private cleanUpRemovedListener;
|
|
4785
4793
|
private getOrCreateEmitter;
|
|
4786
4794
|
listeners: (type: string | symbol) => Function[];
|
|
4787
4795
|
listenerCount: (type: string | symbol) => number;
|
|
4788
4796
|
protected registerEventListener: (eventType: EmitterEventType, options: OpenFin_2.SubscriptionOptions | undefined, applySubscription: (emitter: EventEmitter) => void, undoSubscription: (emitter: EventEmitter) => void) => Promise<void>;
|
|
4789
|
-
|
|
4797
|
+
private deregisterEventListener;
|
|
4790
4798
|
/**
|
|
4791
4799
|
* Adds a listener to the end of the listeners array for the specified event.
|
|
4792
4800
|
*
|
|
@@ -4822,7 +4830,7 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
|
|
|
4822
4830
|
* @remarks Caution: Calling this method changes the array indices in the listener array behind the listener.
|
|
4823
4831
|
*/
|
|
4824
4832
|
removeListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin_2.SubscriptionOptions): Promise<this>;
|
|
4825
|
-
|
|
4833
|
+
private deregisterAllListeners;
|
|
4826
4834
|
/**
|
|
4827
4835
|
* Removes all listeners, or those of the specified event.
|
|
4828
4836
|
*
|
|
@@ -5253,6 +5261,19 @@ declare type ExtensionsInstallFailedEvent = ExtensionsEvent & {
|
|
|
5253
5261
|
type: 'extensions-install-failed';
|
|
5254
5262
|
};
|
|
5255
5263
|
|
|
5264
|
+
/**
|
|
5265
|
+
* these api calls are not implemented in the javscript api, only in the external adapter
|
|
5266
|
+
* If they don't exist in the external adapter they should be removed.
|
|
5267
|
+
*/
|
|
5268
|
+
declare type ExternalAdapterOnlyCalls = 'subscriber-added' | 'subscriber-removed' | 'clipboard-clear' | 'create-proxy-socket' | 'authenticate-proxy-socket' | 'convert-options' | 'generate-guid' | 'get-config' | 'get-remote-config' | 'get-nearest-display-root' | 'get-preload-scripts' | 'raise-event' | 'set-window-preload-state' | 'dock-window' | 'get-current-window-options' | 'redirect-window-to-url' | 'request-new-content' | 'raise-many-events' | 'show-menu' | 'resolve-proxy' | 'undock-window' | 'window-embedded' | 'window-get-cached-bounds' | 'resource-fetch-authenticate' | 'set-cookie';
|
|
5269
|
+
|
|
5270
|
+
declare type ExternalAdapterOnlyCallsMap = {
|
|
5271
|
+
[k in ExternalAdapterOnlyCalls]: {
|
|
5272
|
+
request: any;
|
|
5273
|
+
response: any;
|
|
5274
|
+
};
|
|
5275
|
+
};
|
|
5276
|
+
|
|
5256
5277
|
/**
|
|
5257
5278
|
* An ExternalApplication object representing native language adapter connections to the runtime. Allows
|
|
5258
5279
|
* the developer to listen to {@link OpenFin.ExternalApplicationEvents external application events}.
|
|
@@ -6385,6 +6406,16 @@ declare type IntentMetadata<TargetType = any> = {
|
|
|
6385
6406
|
*/
|
|
6386
6407
|
declare class InterApplicationBus extends Base {
|
|
6387
6408
|
Channel: Channel;
|
|
6409
|
+
/**
|
|
6410
|
+
* Event types for the InterApplicationBus.
|
|
6411
|
+
*
|
|
6412
|
+
* @remarks The `subscriber-added` and `subscriber-removed` events are disabled by default.
|
|
6413
|
+
* To re-enable them, launch the runtime with the `--emit-legacy-iab-events` flag.
|
|
6414
|
+
* These events will be removed in a future version. Use {@link Channel} for connection
|
|
6415
|
+
* lifecycle management instead.
|
|
6416
|
+
*
|
|
6417
|
+
* @deprecated Use {@link Channel} `onConnection` / `onDisconnection` instead.
|
|
6418
|
+
*/
|
|
6388
6419
|
events: {
|
|
6389
6420
|
subscriberAdded: string;
|
|
6390
6421
|
subscriberRemoved: string;
|
|
@@ -9216,11 +9247,11 @@ declare type MutableWindowOptions = {
|
|
|
9216
9247
|
*/
|
|
9217
9248
|
customData: any;
|
|
9218
9249
|
/**
|
|
9219
|
-
* @deprecated Will be removed in runtime version 45
|
|
9220
|
-
* @defaultValue true
|
|
9221
|
-
*
|
|
9222
9250
|
* Show the window's frame.
|
|
9223
9251
|
*
|
|
9252
|
+
* @remarks
|
|
9253
|
+
* This property will not be updatable starting runtime version 45.
|
|
9254
|
+
*
|
|
9224
9255
|
* @default true
|
|
9225
9256
|
*/
|
|
9226
9257
|
frame: boolean;
|
|
@@ -9543,6 +9574,8 @@ declare namespace OpenFin_2 {
|
|
|
9543
9574
|
TabStack,
|
|
9544
9575
|
_Window as Window,
|
|
9545
9576
|
_WindowModule,
|
|
9577
|
+
Clipboard_2 as Clipboard,
|
|
9578
|
+
InterApplicationBus,
|
|
9546
9579
|
InteropClient,
|
|
9547
9580
|
InteropBroker,
|
|
9548
9581
|
InteropModule,
|
|
@@ -12141,7 +12174,7 @@ declare type PropagatedWindowEvent<TargetTopic extends string> = PropagatedEvent
|
|
|
12141
12174
|
*/
|
|
12142
12175
|
declare type PropagatedWindowEventType = PropagatedEvent_3<string>['type'];
|
|
12143
12176
|
|
|
12144
|
-
declare
|
|
12177
|
+
declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap & {
|
|
12145
12178
|
'is-application-running': ApplicationIdentityCall<{}, boolean>;
|
|
12146
12179
|
'destroy-application': ApplicationIdentityCall<{
|
|
12147
12180
|
force: boolean;
|
|
@@ -12208,8 +12241,15 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12208
12241
|
downloadLocation: string;
|
|
12209
12242
|
};
|
|
12210
12243
|
response: void;
|
|
12244
|
+
secure: true;
|
|
12245
|
+
namespace: 'Application';
|
|
12246
|
+
apiPath: '.setFileDownloadLocation';
|
|
12247
|
+
};
|
|
12248
|
+
'get-file-download-location': ApplicationIdentityCall<{}, string> & {
|
|
12249
|
+
secure: true;
|
|
12250
|
+
namespace: 'Application';
|
|
12251
|
+
apiPath: '.getFileDownloadLocation';
|
|
12211
12252
|
};
|
|
12212
|
-
'get-file-download-location': ApplicationIdentityCall<{}, string>;
|
|
12213
12253
|
'show-tray-icon-popup-menu': {
|
|
12214
12254
|
request: OpenFin_2.Identity & {
|
|
12215
12255
|
options: OpenFin_2.ShowTrayIconPopupMenuOptions;
|
|
@@ -12217,19 +12257,17 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12217
12257
|
response: OpenFin_2.MenuResult;
|
|
12218
12258
|
};
|
|
12219
12259
|
'close-tray-icon-popup-menu': IdentityCall<{}, void>;
|
|
12220
|
-
'wrap-application': VoidCall;
|
|
12221
|
-
'wrap-application-sync': VoidCall;
|
|
12222
12260
|
'create-application': ApiCall<OpenFin_2.ApplicationCreationOptions, void>;
|
|
12223
|
-
'application-create': VoidCall;
|
|
12224
|
-
'start-application': VoidCall;
|
|
12225
12261
|
'run-applications': ApiCall<{
|
|
12226
12262
|
applications: Array<OpenFin_2.ManifestInfo>;
|
|
12227
12263
|
opts?: OpenFin_2.RvmLaunchOptions;
|
|
12228
12264
|
}, void>;
|
|
12229
|
-
'
|
|
12230
|
-
|
|
12231
|
-
|
|
12232
|
-
|
|
12265
|
+
'send-analytics-batch': {
|
|
12266
|
+
request: {
|
|
12267
|
+
counts: Record<string, number>;
|
|
12268
|
+
};
|
|
12269
|
+
response: void;
|
|
12270
|
+
};
|
|
12233
12271
|
'request-external-authorization': {
|
|
12234
12272
|
request: any;
|
|
12235
12273
|
response: void;
|
|
@@ -12249,44 +12287,69 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12249
12287
|
'clipboard-read-image': {
|
|
12250
12288
|
request: OpenFin_2.ReadImageClipboardRequest;
|
|
12251
12289
|
response: string;
|
|
12290
|
+
apiPath: '.readImage';
|
|
12291
|
+
namespace: 'Clipboard';
|
|
12252
12292
|
};
|
|
12253
12293
|
'clipboard-read-text': {
|
|
12254
12294
|
request: {
|
|
12255
12295
|
type?: OpenFin_2.ClipboardSelectionType;
|
|
12256
12296
|
};
|
|
12257
12297
|
response: string;
|
|
12298
|
+
apiPath: '.readText';
|
|
12299
|
+
namespace: 'Clipboard';
|
|
12258
12300
|
};
|
|
12259
12301
|
'clipboard-read-html': {
|
|
12260
12302
|
request: {
|
|
12261
12303
|
type?: OpenFin_2.ClipboardSelectionType;
|
|
12262
12304
|
};
|
|
12263
12305
|
response: string;
|
|
12306
|
+
apiPath: '.readHtml';
|
|
12307
|
+
namespace: 'Clipboard';
|
|
12264
12308
|
};
|
|
12265
12309
|
'clipboard-read-rtf': {
|
|
12266
12310
|
request: {
|
|
12267
12311
|
type?: OpenFin_2.ClipboardSelectionType;
|
|
12268
12312
|
};
|
|
12269
12313
|
response: string;
|
|
12314
|
+
apiPath: '.readRtf';
|
|
12315
|
+
namespace: 'Clipboard';
|
|
12270
12316
|
};
|
|
12271
12317
|
'clipboard-write-image': {
|
|
12272
12318
|
request: OpenFin_2.WriteImageClipboardRequest;
|
|
12273
12319
|
response: void;
|
|
12320
|
+
apiPath: '.writeImage';
|
|
12321
|
+
namespace: 'Clipboard';
|
|
12274
12322
|
};
|
|
12275
12323
|
'clipboard-write': {
|
|
12276
12324
|
request: OpenFin_2.WriteAnyRequestType;
|
|
12277
12325
|
response: void;
|
|
12326
|
+
apiPath: '.write';
|
|
12327
|
+
namespace: 'Clipboard';
|
|
12278
12328
|
};
|
|
12279
12329
|
'clipboard-write-text': {
|
|
12280
12330
|
request: OpenFin_2.WriteClipboardRequest;
|
|
12281
12331
|
response: void;
|
|
12332
|
+
apiPath: '.writeText';
|
|
12333
|
+
namespace: 'Clipboard';
|
|
12334
|
+
foo: '';
|
|
12335
|
+
};
|
|
12336
|
+
'set-clipboard': {
|
|
12337
|
+
request: OpenFin_2.WriteClipboardRequest;
|
|
12338
|
+
response: void;
|
|
12339
|
+
apiPath: '.setClipboard';
|
|
12340
|
+
namespace: 'Clipboard';
|
|
12282
12341
|
};
|
|
12283
12342
|
'clipboard-write-html': {
|
|
12284
12343
|
request: OpenFin_2.WriteClipboardRequest;
|
|
12285
12344
|
response: void;
|
|
12345
|
+
apiPath: '.writeHtml';
|
|
12346
|
+
namespace: 'Clipboard';
|
|
12286
12347
|
};
|
|
12287
12348
|
'clipboard-write-rtf': {
|
|
12288
12349
|
request: OpenFin_2.WriteClipboardRequest;
|
|
12289
12350
|
response: void;
|
|
12351
|
+
apiPath: '.writeRtf';
|
|
12352
|
+
namespace: 'Clipboard';
|
|
12290
12353
|
};
|
|
12291
12354
|
'get-view-window': IdentityCall<{}, OpenFin_2.Identity>;
|
|
12292
12355
|
'create-view': IdentityCall<OpenFin_2.ViewCreationOptions & {
|
|
@@ -12313,18 +12376,10 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12313
12376
|
options: OpenFin_2.UpdatableViewOptions;
|
|
12314
12377
|
}>;
|
|
12315
12378
|
'trigger-before-unload': IdentityCall<{}, boolean>;
|
|
12316
|
-
'view-wrap-sync': VoidCall;
|
|
12317
|
-
'view-wrap': VoidCall;
|
|
12318
|
-
'view-get-current': VoidCall;
|
|
12319
|
-
'view-get-current-sync': VoidCall;
|
|
12320
12379
|
'animate-window': IdentityCall<{
|
|
12321
12380
|
transitions: OpenFin_2.Transition;
|
|
12322
12381
|
options: OpenFin_2.TransitionOptions;
|
|
12323
12382
|
}>;
|
|
12324
|
-
'activate-window-and-focus': ApiCall<{
|
|
12325
|
-
winIdentity: OpenFin_2.Identity;
|
|
12326
|
-
focusIdentity: OpenFin_2.Identity;
|
|
12327
|
-
}, boolean>;
|
|
12328
12383
|
'get-all-frames': IdentityCall<{}, OpenFin_2.FrameInfo[]>;
|
|
12329
12384
|
'get-window-bounds': IdentityCall<{
|
|
12330
12385
|
options?: OpenFin_2.GetBoundsOptions;
|
|
@@ -12413,15 +12468,13 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12413
12468
|
'create-window': VoidCall;
|
|
12414
12469
|
'get-current-window': VoidCall;
|
|
12415
12470
|
'get-current-window-sync': VoidCall;
|
|
12471
|
+
'activate-window-and-focus': ApiCall<{
|
|
12472
|
+
winIdentity: OpenFin_2.Identity;
|
|
12473
|
+
focusIdentity: OpenFin_2.Identity;
|
|
12474
|
+
}, boolean>;
|
|
12416
12475
|
'get-external-application-info': ApiCall<OpenFin_2.ApplicationIdentity, OpenFin_2.ExternalApplicationInfo>;
|
|
12417
|
-
'external-application-wrap': VoidCall;
|
|
12418
|
-
'external-application-wrap-sync': VoidCall;
|
|
12419
12476
|
'get-frame-info': ApiCall<OpenFin_2.Identity, OpenFin_2.FrameInfo>;
|
|
12420
12477
|
'get-parent-window': ApiCall<OpenFin_2.Identity, OpenFin_2.FrameInfo>;
|
|
12421
|
-
'frame-wrap': VoidCall;
|
|
12422
|
-
'frame-wrap-sync': VoidCall;
|
|
12423
|
-
'frame-get-current': VoidCall;
|
|
12424
|
-
'frame-get-current-sync': VoidCall;
|
|
12425
12478
|
'global-hotkey-register': {
|
|
12426
12479
|
request: {
|
|
12427
12480
|
hotkey: string;
|
|
@@ -12505,6 +12558,10 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12505
12558
|
request: any;
|
|
12506
12559
|
response: any;
|
|
12507
12560
|
};
|
|
12561
|
+
'send-channel-result': {
|
|
12562
|
+
request: any;
|
|
12563
|
+
response: any;
|
|
12564
|
+
};
|
|
12508
12565
|
'get-version': GetterCall<string>;
|
|
12509
12566
|
'clear-cache': ApiCall<OpenFin_2.ClearCacheOption, void>;
|
|
12510
12567
|
'delete-cache-request': VoidCall;
|
|
@@ -12554,7 +12611,11 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12554
12611
|
action: string;
|
|
12555
12612
|
runtimes: string[];
|
|
12556
12613
|
}>;
|
|
12557
|
-
'get-installed-apps': GetterCall<OpenFin_2.InstalledApps
|
|
12614
|
+
'get-installed-apps': GetterCall<OpenFin_2.InstalledApps> & {
|
|
12615
|
+
secure: true;
|
|
12616
|
+
apiPath: '.getInstalledApps';
|
|
12617
|
+
namespace: 'System';
|
|
12618
|
+
};
|
|
12558
12619
|
'view-log': ApiCall<OpenFin_2.GetLogRequestType, string>;
|
|
12559
12620
|
'get-machine-id': GetterCall<string>;
|
|
12560
12621
|
'get-min-log-level': GetterCall<OpenFin_2.LogLevel>;
|
|
@@ -12567,8 +12628,16 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12567
12628
|
'get-runtime-info': GetterCall<OpenFin_2.RuntimeInfo>;
|
|
12568
12629
|
'get-rvm-info': GetterCall<OpenFin_2.RVMInfo>;
|
|
12569
12630
|
'get-host-specs': GetterCall<OpenFin_2.HostSpecs>;
|
|
12570
|
-
'get-os-info': GetterCall<OpenFin_2.OSInfo
|
|
12571
|
-
|
|
12631
|
+
'get-os-info': GetterCall<OpenFin_2.OSInfo> & {
|
|
12632
|
+
secure: true;
|
|
12633
|
+
apiPath: '.getOSInfo';
|
|
12634
|
+
namespace: 'System';
|
|
12635
|
+
};
|
|
12636
|
+
'launch-external-process': ApiCall<OpenFin_2.ExternalProcessRequestType, OpenFin_2.Identity> & {
|
|
12637
|
+
secure: true;
|
|
12638
|
+
apiPath: '.launchExternalProcess';
|
|
12639
|
+
namespace: 'System';
|
|
12640
|
+
};
|
|
12572
12641
|
'monitor-external-process': ApiCall<OpenFin_2.ExternalProcessInfo, OpenFin_2.Identity>;
|
|
12573
12642
|
'write-to-log': ApiCall<{
|
|
12574
12643
|
level: string;
|
|
@@ -12576,25 +12645,48 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12576
12645
|
}, void>;
|
|
12577
12646
|
'open-url-with-browser': ApiCall<{
|
|
12578
12647
|
url: string;
|
|
12579
|
-
}, void
|
|
12580
|
-
|
|
12648
|
+
}, void> & {
|
|
12649
|
+
secure: true;
|
|
12650
|
+
apiPath: '.openUrlWithBrowser';
|
|
12651
|
+
namespace: 'System';
|
|
12652
|
+
};
|
|
12653
|
+
'register-custom-protocol': ApiCall<OpenFin_2.CustomProtocolOptions, void> & {
|
|
12654
|
+
secure: true;
|
|
12655
|
+
apiPath: '.registerCustomProtocol';
|
|
12656
|
+
namespace: 'System';
|
|
12657
|
+
};
|
|
12581
12658
|
'unregister-custom-protocol': ApiCall<{
|
|
12582
12659
|
protocolName: string;
|
|
12583
|
-
}, void
|
|
12660
|
+
}, void> & {
|
|
12661
|
+
secure: true;
|
|
12662
|
+
apiPath: '.unregisterCustomProtocol';
|
|
12663
|
+
namespace: 'System';
|
|
12664
|
+
};
|
|
12584
12665
|
'get-custom-protocol-state': ApiCall<{
|
|
12585
12666
|
protocolName: string;
|
|
12586
|
-
}, OpenFin_2.CustomProtocolState
|
|
12667
|
+
}, OpenFin_2.CustomProtocolState> & {
|
|
12668
|
+
secure: true;
|
|
12669
|
+
apiPath: '.getCustomProtocolState';
|
|
12670
|
+
namespace: 'System';
|
|
12671
|
+
};
|
|
12587
12672
|
'release-external-process': ApiCall<{
|
|
12588
12673
|
uuid: string;
|
|
12589
12674
|
}, void>;
|
|
12590
12675
|
'show-developer-tools': ApiCall<OpenFin_2.Identity, void>;
|
|
12591
|
-
'terminate-external-process': ApiCall<OpenFin_2.TerminateExternalRequestType, void
|
|
12676
|
+
'terminate-external-process': ApiCall<OpenFin_2.TerminateExternalRequestType, void> & {
|
|
12677
|
+
secure: true;
|
|
12678
|
+
apiPath: '.terminateExternalProcess';
|
|
12679
|
+
namespace: 'System';
|
|
12680
|
+
};
|
|
12592
12681
|
'update-proxy': ApiCall<OpenFin_2.ProxyConfig, void>;
|
|
12593
12682
|
'download-asset': {
|
|
12594
12683
|
request: OpenFin_2.AppAssetInfo & {
|
|
12595
12684
|
downloadId: string;
|
|
12596
12685
|
};
|
|
12597
12686
|
response: void;
|
|
12687
|
+
secure: true;
|
|
12688
|
+
apiPath: '.downloadAsset';
|
|
12689
|
+
namespace: 'System';
|
|
12598
12690
|
};
|
|
12599
12691
|
'download-runtime': {
|
|
12600
12692
|
request: OpenFin_2.RuntimeDownloadOptions & {
|
|
@@ -12623,7 +12715,11 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12623
12715
|
rootKey: string;
|
|
12624
12716
|
subkey: string;
|
|
12625
12717
|
value: string;
|
|
12626
|
-
}, OpenFin_2.RegistryInfo
|
|
12718
|
+
}, OpenFin_2.RegistryInfo> & {
|
|
12719
|
+
secure: true;
|
|
12720
|
+
apiPath: '.readRegistryValue';
|
|
12721
|
+
namespace: 'System';
|
|
12722
|
+
};
|
|
12627
12723
|
'register-external-connection': ApiCall<{
|
|
12628
12724
|
uuid: string;
|
|
12629
12725
|
}, OpenFin_2.ExternalConnection>;
|
|
@@ -12657,26 +12753,48 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12657
12753
|
permissions: any;
|
|
12658
12754
|
};
|
|
12659
12755
|
response: OpenFin_2.NativeWindowIntegrationProviderAuthorization;
|
|
12756
|
+
secure: true;
|
|
12757
|
+
apiPath: '.enableNativeWindowIntegrationProvider';
|
|
12758
|
+
namespace: 'System';
|
|
12660
12759
|
};
|
|
12661
12760
|
'register-usage': ApiCall<OpenFin_2.RegisterUsageData, void>;
|
|
12662
12761
|
'system-get-printers': GetterCall<OpenFin_2.PrinterInfo[]>;
|
|
12663
12762
|
'system-update-process-logging-options': ApiCall<{
|
|
12664
12763
|
options: OpenFin_2.ProcessLoggingOptions;
|
|
12665
12764
|
}, void>;
|
|
12666
|
-
'get-domain-settings': ApiCall<void, OpenFin_2.DomainSettings
|
|
12765
|
+
'get-domain-settings': ApiCall<void, OpenFin_2.DomainSettings> & {
|
|
12766
|
+
secure: true;
|
|
12767
|
+
apiPath: '.getDomainSettings';
|
|
12768
|
+
namespace: 'System';
|
|
12769
|
+
};
|
|
12667
12770
|
'serve-asset': ApiCall<{
|
|
12668
12771
|
options: OpenFin_2.ServeAssetOptions;
|
|
12669
|
-
}, OpenFin_2.ServedAssetInfo
|
|
12772
|
+
}, OpenFin_2.ServedAssetInfo> & {
|
|
12773
|
+
secure: true;
|
|
12774
|
+
apiPath: '.serveAsset';
|
|
12775
|
+
namespace: 'System';
|
|
12776
|
+
};
|
|
12670
12777
|
'set-domain-settings': ApiCall<{
|
|
12671
12778
|
domainSettings: OpenFin_2.DomainSettings;
|
|
12672
|
-
}, void
|
|
12779
|
+
}, void> & {
|
|
12780
|
+
secure: true;
|
|
12781
|
+
apiPath: '.setDomainSettings';
|
|
12782
|
+
namespace: 'System';
|
|
12783
|
+
};
|
|
12673
12784
|
'get-current-domain-settings': ApiCall<{
|
|
12674
12785
|
identity: OpenFin_2.Identity;
|
|
12675
|
-
}, OpenFin_2.ResolvedDomainSettings
|
|
12786
|
+
}, OpenFin_2.ResolvedDomainSettings> & {
|
|
12787
|
+
secure: true;
|
|
12788
|
+
apiPath: '.getCurrentDomainSettings';
|
|
12789
|
+
namespace: 'System';
|
|
12790
|
+
};
|
|
12676
12791
|
'resolve-domain-settings': ApiCall<{
|
|
12677
12792
|
url: string;
|
|
12678
|
-
}, OpenFin_2.ResolvedDomainSettings
|
|
12679
|
-
|
|
12793
|
+
}, OpenFin_2.ResolvedDomainSettings> & {
|
|
12794
|
+
secure: true;
|
|
12795
|
+
apiPath: '.resolveDomainSettings';
|
|
12796
|
+
namespace: 'System';
|
|
12797
|
+
};
|
|
12680
12798
|
'get-permissions': GetterCall<any>;
|
|
12681
12799
|
'refresh-extensions': {
|
|
12682
12800
|
request: void;
|
|
@@ -12686,24 +12804,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12686
12804
|
request: void;
|
|
12687
12805
|
response: OpenFin_2.ExtensionInfo[];
|
|
12688
12806
|
};
|
|
12689
|
-
'fdc3-add-context-listener': VoidCall;
|
|
12690
|
-
'fdc3-add-intent-listener': VoidCall;
|
|
12691
|
-
'fdc3-raise-intent': VoidCall;
|
|
12692
|
-
'fdc3-find-intent': VoidCall;
|
|
12693
|
-
'fdc3-find-intents-by-context': VoidCall;
|
|
12694
|
-
'fdc3-raise-intent-for-context': VoidCall;
|
|
12695
|
-
'fdc3-get-info': VoidCall;
|
|
12696
|
-
'fdc3-find-instances': VoidCall;
|
|
12697
|
-
'fdc3-get-app-metadata': VoidCall;
|
|
12698
|
-
'fdc3-broadcast': VoidCall;
|
|
12699
|
-
'fdc3-open': VoidCall;
|
|
12700
|
-
'fdc3-get-or-create-channel': VoidCall;
|
|
12701
|
-
'fdc3-get-system-channels': VoidCall;
|
|
12702
|
-
'fdc3-join-channel': VoidCall;
|
|
12703
|
-
'fdc3-get-current-channel': VoidCall;
|
|
12704
|
-
'fdc3-leave-current-channel': VoidCall;
|
|
12705
|
-
'interop-init': VoidCall;
|
|
12706
|
-
'interop-connect-sync': VoidCall;
|
|
12707
12807
|
'interop-client-set-context': VoidCall;
|
|
12708
12808
|
'interop-client-add-context-handler': VoidCall;
|
|
12709
12809
|
'interop-client-get-context-groups': VoidCall;
|
|
@@ -12734,12 +12834,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12734
12834
|
'interop-session-context-group-set-context': VoidCall;
|
|
12735
12835
|
'interop-session-context-group-get-context': VoidCall;
|
|
12736
12836
|
'interop-session-context-group-add-handler': VoidCall;
|
|
12737
|
-
'platform-wrap': VoidCall;
|
|
12738
|
-
'platform-wrap-sync': VoidCall;
|
|
12739
|
-
'platform-get-current': VoidCall;
|
|
12740
|
-
'platform-get-current-sync': VoidCall;
|
|
12741
|
-
'platform-start': VoidCall;
|
|
12742
|
-
'platform-start-from-manifest': VoidCall;
|
|
12743
12837
|
'platform-get-client': ApplicationIdentityCall<{}, void>;
|
|
12744
12838
|
'platform-create-view': ApplicationIdentityCall<{}, void>;
|
|
12745
12839
|
'platform-create-window': ApplicationIdentityCall<{}, void>;
|
|
@@ -12752,11 +12846,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12752
12846
|
'platform-set-window-context': ApplicationIdentityCall<{}, void>;
|
|
12753
12847
|
'platform-get-window-context': ApplicationIdentityCall<{}, void>;
|
|
12754
12848
|
'platform-close-window': ApplicationIdentityCall<{}, void>;
|
|
12755
|
-
'layout-wrap': VoidCall;
|
|
12756
|
-
'layout-wrap-sync': VoidCall;
|
|
12757
|
-
'layout-get-current': VoidCall;
|
|
12758
|
-
'layout-get-current-sync': VoidCall;
|
|
12759
|
-
'layout-init': VoidCall;
|
|
12760
12849
|
'layout-get-config': VoidCall;
|
|
12761
12850
|
'layout-get-views': VoidCall;
|
|
12762
12851
|
'layout-replace': VoidCall;
|
|
@@ -12775,12 +12864,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12775
12864
|
'layout-controller-create-adjacent-stack': VoidCall;
|
|
12776
12865
|
'layout-controller-get-adjacent-stacks': VoidCall;
|
|
12777
12866
|
'layout-controller-set-stack-active-view': VoidCall;
|
|
12778
|
-
'snapshot-source-init': VoidCall;
|
|
12779
|
-
'snapshot-source-wrap-sync': VoidCall;
|
|
12780
|
-
'snapshot-source-wrap': VoidCall;
|
|
12781
|
-
'snapshot-source-ready': VoidCall;
|
|
12782
|
-
'snapshot-source-get-snapshot': VoidCall;
|
|
12783
|
-
'snapshot-source-apply-snapshot': VoidCall;
|
|
12784
12867
|
'capture-page': IdentityCall<{
|
|
12785
12868
|
options?: OpenFin_2.CapturePageOptions;
|
|
12786
12869
|
}, string>;
|
|
@@ -12861,15 +12944,27 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12861
12944
|
};
|
|
12862
12945
|
response: void;
|
|
12863
12946
|
};
|
|
12864
|
-
|
|
12865
|
-
|
|
12866
|
-
|
|
12867
|
-
|
|
12868
|
-
|
|
12869
|
-
|
|
12870
|
-
|
|
12947
|
+
'subscribe-to-desktop-event': {
|
|
12948
|
+
request: {
|
|
12949
|
+
topic: string;
|
|
12950
|
+
type: string;
|
|
12951
|
+
uuid?: string;
|
|
12952
|
+
name?: string;
|
|
12953
|
+
timestamp?: number;
|
|
12954
|
+
};
|
|
12955
|
+
response: void;
|
|
12871
12956
|
};
|
|
12872
|
-
|
|
12957
|
+
'unsubscribe-to-desktop-event': {
|
|
12958
|
+
request: {
|
|
12959
|
+
topic: string;
|
|
12960
|
+
type: string;
|
|
12961
|
+
uuid?: string;
|
|
12962
|
+
name?: string;
|
|
12963
|
+
timestamp?: number;
|
|
12964
|
+
};
|
|
12965
|
+
response: void;
|
|
12966
|
+
};
|
|
12967
|
+
};
|
|
12873
12968
|
|
|
12874
12969
|
declare type ProtocolOffer = ClassicProtocolOffer | RTCProtocolOffer;
|
|
12875
12970
|
|
|
@@ -13435,7 +13530,9 @@ declare type SecurityRealmEvent = BaseEvent_9 & {
|
|
|
13435
13530
|
|
|
13436
13531
|
declare type SendActionResponse<T extends keyof ProtocolMap> = Message<{
|
|
13437
13532
|
data: ProtocolMap[T]['response'];
|
|
13438
|
-
} & ProtocolMap[T]
|
|
13533
|
+
} & (ProtocolMap[T] extends {
|
|
13534
|
+
specialResponse: infer U;
|
|
13535
|
+
} ? U : {})>;
|
|
13439
13536
|
|
|
13440
13537
|
/**
|
|
13441
13538
|
* @interface
|
|
@@ -13944,13 +14041,15 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
13944
14041
|
* * cookies: browser [cookies](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies)
|
|
13945
14042
|
* * localStorage: browser data that can be used across sessions ([local storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage))
|
|
13946
14043
|
* * appcache: html5 [application cache](https://developer.mozilla.org/en-US/docs/Web/HTML/Using_the_application_cache)
|
|
14044
|
+
* * windowState: clears data written for windows using `saveWindowState`; after clearing, previously saved bounds and state will not be restored until new state is written
|
|
13947
14045
|
* @example
|
|
13948
14046
|
* ```js
|
|
13949
14047
|
* const clearCacheOptions = {
|
|
13950
14048
|
* appcache: true,
|
|
13951
14049
|
* cache: true,
|
|
13952
14050
|
* cookies: true,
|
|
13953
|
-
* localStorage: true
|
|
14051
|
+
* localStorage: true,
|
|
14052
|
+
* windowState: true
|
|
13954
14053
|
* };
|
|
13955
14054
|
* fin.System.clearCache(clearCacheOptions).then(() => console.log('Cache cleared')).catch(err => console.log(err));
|
|
13956
14055
|
* ```
|
|
@@ -15448,7 +15547,6 @@ declare type SystemEventType = EventType_8;
|
|
|
15448
15547
|
*/
|
|
15449
15548
|
declare type SystemPermissions = {
|
|
15450
15549
|
getOSInfo: boolean;
|
|
15451
|
-
getAllExternalWindows: boolean;
|
|
15452
15550
|
setDomainSettings: boolean;
|
|
15453
15551
|
getDomainSettings: boolean;
|
|
15454
15552
|
getCurrentDomainSettings: boolean;
|
|
@@ -15488,6 +15586,10 @@ declare type SystemPermissions = {
|
|
|
15488
15586
|
enabled: boolean;
|
|
15489
15587
|
protocols: string[];
|
|
15490
15588
|
};
|
|
15589
|
+
getInstalledApps: boolean;
|
|
15590
|
+
downloadAsset: boolean;
|
|
15591
|
+
serveAsset: boolean;
|
|
15592
|
+
enableNativeWindowIntegrationProvider: boolean;
|
|
15491
15593
|
};
|
|
15492
15594
|
|
|
15493
15595
|
/**
|
|
@@ -15789,9 +15891,12 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
|
|
|
15789
15891
|
sendRaw: Wire['send'];
|
|
15790
15892
|
eventAggregator: EventAggregator;
|
|
15791
15893
|
protected messageHandlers: MessageHandler[];
|
|
15792
|
-
constructor(factory: WireFactory, environment: Environment, config: OpenFin_2.Identity
|
|
15894
|
+
constructor(factory: WireFactory, environment: Environment, config: OpenFin_2.Identity & {
|
|
15895
|
+
apiDiagnostics?: boolean;
|
|
15896
|
+
});
|
|
15793
15897
|
getFin(): OpenFin_2.Fin<MeType>;
|
|
15794
15898
|
registerFin(_fin: OpenFin_2.Fin<MeType>): void;
|
|
15899
|
+
recordAnalytic(action: string): void;
|
|
15795
15900
|
connectSync: () => void;
|
|
15796
15901
|
getPort: () => string;
|
|
15797
15902
|
shutdown(): Promise<void>;
|
|
@@ -15799,7 +15904,7 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
|
|
|
15799
15904
|
private connectRemote;
|
|
15800
15905
|
connectByPort(config: ExistingConnectConfig): Promise<void>;
|
|
15801
15906
|
private authorize;
|
|
15802
|
-
sendAction<T extends keyof ProtocolMap
|
|
15907
|
+
sendAction<T extends keyof ProtocolMap>(action: T, payload?: ProtocolMap[T]['request'], uncorrelated?: boolean): SentMessage<SendActionResponse<T>>;
|
|
15803
15908
|
protected nackHandler(payloadOrMessage: RuntimeErrorPayload | string, reject: Function, callSites?: NodeJS.CallSite[]): void;
|
|
15804
15909
|
ferryAction(origData: any): Promise<Message<any>>;
|
|
15805
15910
|
registerMessageHandler(handler: MessageHandler): void;
|