@openfin/core 41.103.2 → 41.103.9
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 +202 -101
- package/out/mock-beta.d.ts +202 -101
- package/out/mock-public.d.ts +202 -101
- package/out/stub.d.ts +202 -101
- package/out/stub.js +1240 -1431
- package/package.json +41 -36
package/out/stub.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>;
|
|
@@ -1708,6 +1714,7 @@ declare type BaseConfig = {
|
|
|
1708
1714
|
devToolsPort?: number;
|
|
1709
1715
|
installerUI?: boolean;
|
|
1710
1716
|
runtime?: RuntimeConfig;
|
|
1717
|
+
apiDiagnostics?: boolean;
|
|
1711
1718
|
appAssets?: [
|
|
1712
1719
|
{
|
|
1713
1720
|
src: string;
|
|
@@ -3089,6 +3096,11 @@ declare type ClearCacheOption = {
|
|
|
3089
3096
|
* browser data that can be used across sessions
|
|
3090
3097
|
*/
|
|
3091
3098
|
localStorage?: boolean;
|
|
3099
|
+
/**
|
|
3100
|
+
* Clears saved window-state data written for windows that use `saveWindowState`.
|
|
3101
|
+
* After this data is cleared, previously persisted bounds and state (Maximized/Minimized) will not be restored until new state is written again.
|
|
3102
|
+
*/
|
|
3103
|
+
windowState?: boolean;
|
|
3092
3104
|
};
|
|
3093
3105
|
|
|
3094
3106
|
/**
|
|
@@ -3314,6 +3326,7 @@ declare type ClipboardApiPermissions = {
|
|
|
3314
3326
|
writeRtf: boolean;
|
|
3315
3327
|
readRtf: boolean;
|
|
3316
3328
|
write: boolean;
|
|
3329
|
+
setClipboard: boolean;
|
|
3317
3330
|
};
|
|
3318
3331
|
|
|
3319
3332
|
/**
|
|
@@ -4837,20 +4850,11 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
|
|
|
4837
4850
|
type: EventType;
|
|
4838
4851
|
}>, ...args: any[]) => boolean;
|
|
4839
4852
|
private hasEmitter;
|
|
4840
|
-
/**
|
|
4841
|
-
* Cleans up after removal of a listener, e.g. deleting any lingering deregistration handlers for a
|
|
4842
|
-
* `once` subscription.
|
|
4843
|
-
*
|
|
4844
|
-
* @remarks Implementing this as a `removeListener` handler ensures that direct removal of a listener
|
|
4845
|
-
* on the base emitter will not leak additional core handlers. We could do this in the forwarding method,
|
|
4846
|
-
* which would involve less "magic," but would be more-vulnerable to accidental re-introduction of a leak.
|
|
4847
|
-
*/
|
|
4848
|
-
private cleanUpRemovedListener;
|
|
4849
4853
|
private getOrCreateEmitter;
|
|
4850
4854
|
listeners: (type: string | symbol) => Function[];
|
|
4851
4855
|
listenerCount: (type: string | symbol) => number;
|
|
4852
4856
|
protected registerEventListener: (eventType: EmitterEventType, options: OpenFin_2.SubscriptionOptions | undefined, applySubscription: (emitter: EventEmitter) => void, undoSubscription: (emitter: EventEmitter) => void) => Promise<void>;
|
|
4853
|
-
|
|
4857
|
+
private deregisterEventListener;
|
|
4854
4858
|
/**
|
|
4855
4859
|
* Adds a listener to the end of the listeners array for the specified event.
|
|
4856
4860
|
*
|
|
@@ -4886,7 +4890,7 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
|
|
|
4886
4890
|
* @remarks Caution: Calling this method changes the array indices in the listener array behind the listener.
|
|
4887
4891
|
*/
|
|
4888
4892
|
removeListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin_2.SubscriptionOptions): Promise<this>;
|
|
4889
|
-
|
|
4893
|
+
private deregisterAllListeners;
|
|
4890
4894
|
/**
|
|
4891
4895
|
* Removes all listeners, or those of the specified event.
|
|
4892
4896
|
*
|
|
@@ -5335,6 +5339,19 @@ declare type ExtensionsInstallFailedEvent = ExtensionsEvent & {
|
|
|
5335
5339
|
type: 'extensions-install-failed';
|
|
5336
5340
|
};
|
|
5337
5341
|
|
|
5342
|
+
/**
|
|
5343
|
+
* these api calls are not implemented in the javscript api, only in the external adapter
|
|
5344
|
+
* If they don't exist in the external adapter they should be removed.
|
|
5345
|
+
*/
|
|
5346
|
+
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';
|
|
5347
|
+
|
|
5348
|
+
declare type ExternalAdapterOnlyCallsMap = {
|
|
5349
|
+
[k in ExternalAdapterOnlyCalls]: {
|
|
5350
|
+
request: any;
|
|
5351
|
+
response: any;
|
|
5352
|
+
};
|
|
5353
|
+
};
|
|
5354
|
+
|
|
5338
5355
|
/**
|
|
5339
5356
|
* An ExternalApplication object representing native language adapter connections to the runtime. Allows
|
|
5340
5357
|
* the developer to listen to {@link OpenFin.ExternalApplicationEvents external application events}.
|
|
@@ -6479,6 +6496,16 @@ declare type IntentMetadata<TargetType = any> = {
|
|
|
6479
6496
|
*/
|
|
6480
6497
|
declare class InterApplicationBus extends Base {
|
|
6481
6498
|
Channel: Channel;
|
|
6499
|
+
/**
|
|
6500
|
+
* Event types for the InterApplicationBus.
|
|
6501
|
+
*
|
|
6502
|
+
* @remarks The `subscriber-added` and `subscriber-removed` events are disabled by default.
|
|
6503
|
+
* To re-enable them, launch the runtime with the `--emit-legacy-iab-events` flag.
|
|
6504
|
+
* These events will be removed in a future version. Use {@link Channel} for connection
|
|
6505
|
+
* lifecycle management instead.
|
|
6506
|
+
*
|
|
6507
|
+
* @deprecated Use {@link Channel} `onConnection` / `onDisconnection` instead.
|
|
6508
|
+
*/
|
|
6482
6509
|
events: {
|
|
6483
6510
|
subscriberAdded: string;
|
|
6484
6511
|
subscriberRemoved: string;
|
|
@@ -9516,11 +9543,11 @@ declare type MutableWindowOptions = {
|
|
|
9516
9543
|
*/
|
|
9517
9544
|
customData: any;
|
|
9518
9545
|
/**
|
|
9519
|
-
* @deprecated Will be removed in runtime version 45
|
|
9520
|
-
* @defaultValue true
|
|
9521
|
-
*
|
|
9522
9546
|
* Show the window's frame.
|
|
9523
9547
|
*
|
|
9548
|
+
* @remarks
|
|
9549
|
+
* This property will not be updatable starting runtime version 45.
|
|
9550
|
+
*
|
|
9524
9551
|
* @default true
|
|
9525
9552
|
*/
|
|
9526
9553
|
frame: boolean;
|
|
@@ -9861,6 +9888,8 @@ declare namespace OpenFin_2 {
|
|
|
9861
9888
|
TabStack,
|
|
9862
9889
|
_Window as Window,
|
|
9863
9890
|
_WindowModule,
|
|
9891
|
+
Clipboard_2 as Clipboard,
|
|
9892
|
+
InterApplicationBus,
|
|
9864
9893
|
InteropClient,
|
|
9865
9894
|
InteropBroker,
|
|
9866
9895
|
InteropModule,
|
|
@@ -12542,7 +12571,7 @@ declare type PropagatedWindowEvent<TargetTopic extends string> = PropagatedEvent
|
|
|
12542
12571
|
*/
|
|
12543
12572
|
declare type PropagatedWindowEventType = PropagatedEvent_3<string>['type'];
|
|
12544
12573
|
|
|
12545
|
-
declare
|
|
12574
|
+
declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap & {
|
|
12546
12575
|
'is-application-running': ApplicationIdentityCall<{}, boolean>;
|
|
12547
12576
|
'destroy-application': ApplicationIdentityCall<{
|
|
12548
12577
|
force: boolean;
|
|
@@ -12609,8 +12638,15 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12609
12638
|
downloadLocation: string;
|
|
12610
12639
|
};
|
|
12611
12640
|
response: void;
|
|
12641
|
+
secure: true;
|
|
12642
|
+
namespace: 'Application';
|
|
12643
|
+
apiPath: '.setFileDownloadLocation';
|
|
12644
|
+
};
|
|
12645
|
+
'get-file-download-location': ApplicationIdentityCall<{}, string> & {
|
|
12646
|
+
secure: true;
|
|
12647
|
+
namespace: 'Application';
|
|
12648
|
+
apiPath: '.getFileDownloadLocation';
|
|
12612
12649
|
};
|
|
12613
|
-
'get-file-download-location': ApplicationIdentityCall<{}, string>;
|
|
12614
12650
|
'show-tray-icon-popup-menu': {
|
|
12615
12651
|
request: OpenFin_2.Identity & {
|
|
12616
12652
|
options: OpenFin_2.ShowTrayIconPopupMenuOptions;
|
|
@@ -12618,19 +12654,17 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12618
12654
|
response: OpenFin_2.MenuResult;
|
|
12619
12655
|
};
|
|
12620
12656
|
'close-tray-icon-popup-menu': IdentityCall<{}, void>;
|
|
12621
|
-
'wrap-application': VoidCall;
|
|
12622
|
-
'wrap-application-sync': VoidCall;
|
|
12623
12657
|
'create-application': ApiCall<OpenFin_2.ApplicationCreationOptions, void>;
|
|
12624
|
-
'application-create': VoidCall;
|
|
12625
|
-
'start-application': VoidCall;
|
|
12626
12658
|
'run-applications': ApiCall<{
|
|
12627
12659
|
applications: Array<OpenFin_2.ManifestInfo>;
|
|
12628
12660
|
opts?: OpenFin_2.RvmLaunchOptions;
|
|
12629
12661
|
}, void>;
|
|
12630
|
-
'
|
|
12631
|
-
|
|
12632
|
-
|
|
12633
|
-
|
|
12662
|
+
'send-analytics-batch': {
|
|
12663
|
+
request: {
|
|
12664
|
+
counts: Record<string, number>;
|
|
12665
|
+
};
|
|
12666
|
+
response: void;
|
|
12667
|
+
};
|
|
12634
12668
|
'request-external-authorization': {
|
|
12635
12669
|
request: any;
|
|
12636
12670
|
response: void;
|
|
@@ -12650,44 +12684,69 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12650
12684
|
'clipboard-read-image': {
|
|
12651
12685
|
request: OpenFin_2.ReadImageClipboardRequest;
|
|
12652
12686
|
response: string;
|
|
12687
|
+
apiPath: '.readImage';
|
|
12688
|
+
namespace: 'Clipboard';
|
|
12653
12689
|
};
|
|
12654
12690
|
'clipboard-read-text': {
|
|
12655
12691
|
request: {
|
|
12656
12692
|
type?: OpenFin_2.ClipboardSelectionType;
|
|
12657
12693
|
};
|
|
12658
12694
|
response: string;
|
|
12695
|
+
apiPath: '.readText';
|
|
12696
|
+
namespace: 'Clipboard';
|
|
12659
12697
|
};
|
|
12660
12698
|
'clipboard-read-html': {
|
|
12661
12699
|
request: {
|
|
12662
12700
|
type?: OpenFin_2.ClipboardSelectionType;
|
|
12663
12701
|
};
|
|
12664
12702
|
response: string;
|
|
12703
|
+
apiPath: '.readHtml';
|
|
12704
|
+
namespace: 'Clipboard';
|
|
12665
12705
|
};
|
|
12666
12706
|
'clipboard-read-rtf': {
|
|
12667
12707
|
request: {
|
|
12668
12708
|
type?: OpenFin_2.ClipboardSelectionType;
|
|
12669
12709
|
};
|
|
12670
12710
|
response: string;
|
|
12711
|
+
apiPath: '.readRtf';
|
|
12712
|
+
namespace: 'Clipboard';
|
|
12671
12713
|
};
|
|
12672
12714
|
'clipboard-write-image': {
|
|
12673
12715
|
request: OpenFin_2.WriteImageClipboardRequest;
|
|
12674
12716
|
response: void;
|
|
12717
|
+
apiPath: '.writeImage';
|
|
12718
|
+
namespace: 'Clipboard';
|
|
12675
12719
|
};
|
|
12676
12720
|
'clipboard-write': {
|
|
12677
12721
|
request: OpenFin_2.WriteAnyRequestType;
|
|
12678
12722
|
response: void;
|
|
12723
|
+
apiPath: '.write';
|
|
12724
|
+
namespace: 'Clipboard';
|
|
12679
12725
|
};
|
|
12680
12726
|
'clipboard-write-text': {
|
|
12681
12727
|
request: OpenFin_2.WriteClipboardRequest;
|
|
12682
12728
|
response: void;
|
|
12729
|
+
apiPath: '.writeText';
|
|
12730
|
+
namespace: 'Clipboard';
|
|
12731
|
+
foo: '';
|
|
12732
|
+
};
|
|
12733
|
+
'set-clipboard': {
|
|
12734
|
+
request: OpenFin_2.WriteClipboardRequest;
|
|
12735
|
+
response: void;
|
|
12736
|
+
apiPath: '.setClipboard';
|
|
12737
|
+
namespace: 'Clipboard';
|
|
12683
12738
|
};
|
|
12684
12739
|
'clipboard-write-html': {
|
|
12685
12740
|
request: OpenFin_2.WriteClipboardRequest;
|
|
12686
12741
|
response: void;
|
|
12742
|
+
apiPath: '.writeHtml';
|
|
12743
|
+
namespace: 'Clipboard';
|
|
12687
12744
|
};
|
|
12688
12745
|
'clipboard-write-rtf': {
|
|
12689
12746
|
request: OpenFin_2.WriteClipboardRequest;
|
|
12690
12747
|
response: void;
|
|
12748
|
+
apiPath: '.writeRtf';
|
|
12749
|
+
namespace: 'Clipboard';
|
|
12691
12750
|
};
|
|
12692
12751
|
'get-view-window': IdentityCall<{}, OpenFin_2.Identity>;
|
|
12693
12752
|
'create-view': IdentityCall<OpenFin_2.ViewCreationOptions & {
|
|
@@ -12714,18 +12773,10 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12714
12773
|
options: OpenFin_2.UpdatableViewOptions;
|
|
12715
12774
|
}>;
|
|
12716
12775
|
'trigger-before-unload': IdentityCall<{}, boolean>;
|
|
12717
|
-
'view-wrap-sync': VoidCall;
|
|
12718
|
-
'view-wrap': VoidCall;
|
|
12719
|
-
'view-get-current': VoidCall;
|
|
12720
|
-
'view-get-current-sync': VoidCall;
|
|
12721
12776
|
'animate-window': IdentityCall<{
|
|
12722
12777
|
transitions: OpenFin_2.Transition;
|
|
12723
12778
|
options: OpenFin_2.TransitionOptions;
|
|
12724
12779
|
}>;
|
|
12725
|
-
'activate-window-and-focus': ApiCall<{
|
|
12726
|
-
winIdentity: OpenFin_2.Identity;
|
|
12727
|
-
focusIdentity: OpenFin_2.Identity;
|
|
12728
|
-
}, boolean>;
|
|
12729
12780
|
'get-all-frames': IdentityCall<{}, OpenFin_2.FrameInfo[]>;
|
|
12730
12781
|
'get-window-bounds': IdentityCall<{
|
|
12731
12782
|
options?: OpenFin_2.GetBoundsOptions;
|
|
@@ -12814,15 +12865,13 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12814
12865
|
'create-window': VoidCall;
|
|
12815
12866
|
'get-current-window': VoidCall;
|
|
12816
12867
|
'get-current-window-sync': VoidCall;
|
|
12868
|
+
'activate-window-and-focus': ApiCall<{
|
|
12869
|
+
winIdentity: OpenFin_2.Identity;
|
|
12870
|
+
focusIdentity: OpenFin_2.Identity;
|
|
12871
|
+
}, boolean>;
|
|
12817
12872
|
'get-external-application-info': ApiCall<OpenFin_2.ApplicationIdentity, OpenFin_2.ExternalApplicationInfo>;
|
|
12818
|
-
'external-application-wrap': VoidCall;
|
|
12819
|
-
'external-application-wrap-sync': VoidCall;
|
|
12820
12873
|
'get-frame-info': ApiCall<OpenFin_2.Identity, OpenFin_2.FrameInfo>;
|
|
12821
12874
|
'get-parent-window': ApiCall<OpenFin_2.Identity, OpenFin_2.FrameInfo>;
|
|
12822
|
-
'frame-wrap': VoidCall;
|
|
12823
|
-
'frame-wrap-sync': VoidCall;
|
|
12824
|
-
'frame-get-current': VoidCall;
|
|
12825
|
-
'frame-get-current-sync': VoidCall;
|
|
12826
12875
|
'global-hotkey-register': {
|
|
12827
12876
|
request: {
|
|
12828
12877
|
hotkey: string;
|
|
@@ -12906,6 +12955,10 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12906
12955
|
request: any;
|
|
12907
12956
|
response: any;
|
|
12908
12957
|
};
|
|
12958
|
+
'send-channel-result': {
|
|
12959
|
+
request: any;
|
|
12960
|
+
response: any;
|
|
12961
|
+
};
|
|
12909
12962
|
'get-version': GetterCall<string>;
|
|
12910
12963
|
'clear-cache': ApiCall<OpenFin_2.ClearCacheOption, void>;
|
|
12911
12964
|
'delete-cache-request': VoidCall;
|
|
@@ -12955,7 +13008,11 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12955
13008
|
action: string;
|
|
12956
13009
|
runtimes: string[];
|
|
12957
13010
|
}>;
|
|
12958
|
-
'get-installed-apps': GetterCall<OpenFin_2.InstalledApps
|
|
13011
|
+
'get-installed-apps': GetterCall<OpenFin_2.InstalledApps> & {
|
|
13012
|
+
secure: true;
|
|
13013
|
+
apiPath: '.getInstalledApps';
|
|
13014
|
+
namespace: 'System';
|
|
13015
|
+
};
|
|
12959
13016
|
'view-log': ApiCall<OpenFin_2.GetLogRequestType, string>;
|
|
12960
13017
|
'get-machine-id': GetterCall<string>;
|
|
12961
13018
|
'get-min-log-level': GetterCall<OpenFin_2.LogLevel>;
|
|
@@ -12968,8 +13025,16 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12968
13025
|
'get-runtime-info': GetterCall<OpenFin_2.RuntimeInfo>;
|
|
12969
13026
|
'get-rvm-info': GetterCall<OpenFin_2.RVMInfo>;
|
|
12970
13027
|
'get-host-specs': GetterCall<OpenFin_2.HostSpecs>;
|
|
12971
|
-
'get-os-info': GetterCall<OpenFin_2.OSInfo
|
|
12972
|
-
|
|
13028
|
+
'get-os-info': GetterCall<OpenFin_2.OSInfo> & {
|
|
13029
|
+
secure: true;
|
|
13030
|
+
apiPath: '.getOSInfo';
|
|
13031
|
+
namespace: 'System';
|
|
13032
|
+
};
|
|
13033
|
+
'launch-external-process': ApiCall<OpenFin_2.ExternalProcessRequestType, OpenFin_2.Identity> & {
|
|
13034
|
+
secure: true;
|
|
13035
|
+
apiPath: '.launchExternalProcess';
|
|
13036
|
+
namespace: 'System';
|
|
13037
|
+
};
|
|
12973
13038
|
'monitor-external-process': ApiCall<OpenFin_2.ExternalProcessInfo, OpenFin_2.Identity>;
|
|
12974
13039
|
'write-to-log': ApiCall<{
|
|
12975
13040
|
level: string;
|
|
@@ -12977,25 +13042,48 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12977
13042
|
}, void>;
|
|
12978
13043
|
'open-url-with-browser': ApiCall<{
|
|
12979
13044
|
url: string;
|
|
12980
|
-
}, void
|
|
12981
|
-
|
|
13045
|
+
}, void> & {
|
|
13046
|
+
secure: true;
|
|
13047
|
+
apiPath: '.openUrlWithBrowser';
|
|
13048
|
+
namespace: 'System';
|
|
13049
|
+
};
|
|
13050
|
+
'register-custom-protocol': ApiCall<OpenFin_2.CustomProtocolOptions, void> & {
|
|
13051
|
+
secure: true;
|
|
13052
|
+
apiPath: '.registerCustomProtocol';
|
|
13053
|
+
namespace: 'System';
|
|
13054
|
+
};
|
|
12982
13055
|
'unregister-custom-protocol': ApiCall<{
|
|
12983
13056
|
protocolName: string;
|
|
12984
|
-
}, void
|
|
13057
|
+
}, void> & {
|
|
13058
|
+
secure: true;
|
|
13059
|
+
apiPath: '.unregisterCustomProtocol';
|
|
13060
|
+
namespace: 'System';
|
|
13061
|
+
};
|
|
12985
13062
|
'get-custom-protocol-state': ApiCall<{
|
|
12986
13063
|
protocolName: string;
|
|
12987
|
-
}, OpenFin_2.CustomProtocolState
|
|
13064
|
+
}, OpenFin_2.CustomProtocolState> & {
|
|
13065
|
+
secure: true;
|
|
13066
|
+
apiPath: '.getCustomProtocolState';
|
|
13067
|
+
namespace: 'System';
|
|
13068
|
+
};
|
|
12988
13069
|
'release-external-process': ApiCall<{
|
|
12989
13070
|
uuid: string;
|
|
12990
13071
|
}, void>;
|
|
12991
13072
|
'show-developer-tools': ApiCall<OpenFin_2.Identity, void>;
|
|
12992
|
-
'terminate-external-process': ApiCall<OpenFin_2.TerminateExternalRequestType, void
|
|
13073
|
+
'terminate-external-process': ApiCall<OpenFin_2.TerminateExternalRequestType, void> & {
|
|
13074
|
+
secure: true;
|
|
13075
|
+
apiPath: '.terminateExternalProcess';
|
|
13076
|
+
namespace: 'System';
|
|
13077
|
+
};
|
|
12993
13078
|
'update-proxy': ApiCall<OpenFin_2.ProxyConfig, void>;
|
|
12994
13079
|
'download-asset': {
|
|
12995
13080
|
request: OpenFin_2.AppAssetInfo & {
|
|
12996
13081
|
downloadId: string;
|
|
12997
13082
|
};
|
|
12998
13083
|
response: void;
|
|
13084
|
+
secure: true;
|
|
13085
|
+
apiPath: '.downloadAsset';
|
|
13086
|
+
namespace: 'System';
|
|
12999
13087
|
};
|
|
13000
13088
|
'download-runtime': {
|
|
13001
13089
|
request: OpenFin_2.RuntimeDownloadOptions & {
|
|
@@ -13024,7 +13112,11 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13024
13112
|
rootKey: string;
|
|
13025
13113
|
subkey: string;
|
|
13026
13114
|
value: string;
|
|
13027
|
-
}, OpenFin_2.RegistryInfo
|
|
13115
|
+
}, OpenFin_2.RegistryInfo> & {
|
|
13116
|
+
secure: true;
|
|
13117
|
+
apiPath: '.readRegistryValue';
|
|
13118
|
+
namespace: 'System';
|
|
13119
|
+
};
|
|
13028
13120
|
'register-external-connection': ApiCall<{
|
|
13029
13121
|
uuid: string;
|
|
13030
13122
|
}, OpenFin_2.ExternalConnection>;
|
|
@@ -13058,26 +13150,48 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13058
13150
|
permissions: any;
|
|
13059
13151
|
};
|
|
13060
13152
|
response: OpenFin_2.NativeWindowIntegrationProviderAuthorization;
|
|
13153
|
+
secure: true;
|
|
13154
|
+
apiPath: '.enableNativeWindowIntegrationProvider';
|
|
13155
|
+
namespace: 'System';
|
|
13061
13156
|
};
|
|
13062
13157
|
'register-usage': ApiCall<OpenFin_2.RegisterUsageData, void>;
|
|
13063
13158
|
'system-get-printers': GetterCall<OpenFin_2.PrinterInfo[]>;
|
|
13064
13159
|
'system-update-process-logging-options': ApiCall<{
|
|
13065
13160
|
options: OpenFin_2.ProcessLoggingOptions;
|
|
13066
13161
|
}, void>;
|
|
13067
|
-
'get-domain-settings': ApiCall<void, OpenFin_2.DomainSettings
|
|
13162
|
+
'get-domain-settings': ApiCall<void, OpenFin_2.DomainSettings> & {
|
|
13163
|
+
secure: true;
|
|
13164
|
+
apiPath: '.getDomainSettings';
|
|
13165
|
+
namespace: 'System';
|
|
13166
|
+
};
|
|
13068
13167
|
'serve-asset': ApiCall<{
|
|
13069
13168
|
options: OpenFin_2.ServeAssetOptions;
|
|
13070
|
-
}, OpenFin_2.ServedAssetInfo
|
|
13169
|
+
}, OpenFin_2.ServedAssetInfo> & {
|
|
13170
|
+
secure: true;
|
|
13171
|
+
apiPath: '.serveAsset';
|
|
13172
|
+
namespace: 'System';
|
|
13173
|
+
};
|
|
13071
13174
|
'set-domain-settings': ApiCall<{
|
|
13072
13175
|
domainSettings: OpenFin_2.DomainSettings;
|
|
13073
|
-
}, void
|
|
13176
|
+
}, void> & {
|
|
13177
|
+
secure: true;
|
|
13178
|
+
apiPath: '.setDomainSettings';
|
|
13179
|
+
namespace: 'System';
|
|
13180
|
+
};
|
|
13074
13181
|
'get-current-domain-settings': ApiCall<{
|
|
13075
13182
|
identity: OpenFin_2.Identity;
|
|
13076
|
-
}, OpenFin_2.ResolvedDomainSettings
|
|
13183
|
+
}, OpenFin_2.ResolvedDomainSettings> & {
|
|
13184
|
+
secure: true;
|
|
13185
|
+
apiPath: '.getCurrentDomainSettings';
|
|
13186
|
+
namespace: 'System';
|
|
13187
|
+
};
|
|
13077
13188
|
'resolve-domain-settings': ApiCall<{
|
|
13078
13189
|
url: string;
|
|
13079
|
-
}, OpenFin_2.ResolvedDomainSettings
|
|
13080
|
-
|
|
13190
|
+
}, OpenFin_2.ResolvedDomainSettings> & {
|
|
13191
|
+
secure: true;
|
|
13192
|
+
apiPath: '.resolveDomainSettings';
|
|
13193
|
+
namespace: 'System';
|
|
13194
|
+
};
|
|
13081
13195
|
'get-permissions': GetterCall<any>;
|
|
13082
13196
|
'refresh-extensions': {
|
|
13083
13197
|
request: void;
|
|
@@ -13087,24 +13201,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13087
13201
|
request: void;
|
|
13088
13202
|
response: OpenFin_2.ExtensionInfo[];
|
|
13089
13203
|
};
|
|
13090
|
-
'fdc3-add-context-listener': VoidCall;
|
|
13091
|
-
'fdc3-add-intent-listener': VoidCall;
|
|
13092
|
-
'fdc3-raise-intent': VoidCall;
|
|
13093
|
-
'fdc3-find-intent': VoidCall;
|
|
13094
|
-
'fdc3-find-intents-by-context': VoidCall;
|
|
13095
|
-
'fdc3-raise-intent-for-context': VoidCall;
|
|
13096
|
-
'fdc3-get-info': VoidCall;
|
|
13097
|
-
'fdc3-find-instances': VoidCall;
|
|
13098
|
-
'fdc3-get-app-metadata': VoidCall;
|
|
13099
|
-
'fdc3-broadcast': VoidCall;
|
|
13100
|
-
'fdc3-open': VoidCall;
|
|
13101
|
-
'fdc3-get-or-create-channel': VoidCall;
|
|
13102
|
-
'fdc3-get-system-channels': VoidCall;
|
|
13103
|
-
'fdc3-join-channel': VoidCall;
|
|
13104
|
-
'fdc3-get-current-channel': VoidCall;
|
|
13105
|
-
'fdc3-leave-current-channel': VoidCall;
|
|
13106
|
-
'interop-init': VoidCall;
|
|
13107
|
-
'interop-connect-sync': VoidCall;
|
|
13108
13204
|
'interop-client-set-context': VoidCall;
|
|
13109
13205
|
'interop-client-add-context-handler': VoidCall;
|
|
13110
13206
|
'interop-client-get-context-groups': VoidCall;
|
|
@@ -13135,12 +13231,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13135
13231
|
'interop-session-context-group-set-context': VoidCall;
|
|
13136
13232
|
'interop-session-context-group-get-context': VoidCall;
|
|
13137
13233
|
'interop-session-context-group-add-handler': VoidCall;
|
|
13138
|
-
'platform-wrap': VoidCall;
|
|
13139
|
-
'platform-wrap-sync': VoidCall;
|
|
13140
|
-
'platform-get-current': VoidCall;
|
|
13141
|
-
'platform-get-current-sync': VoidCall;
|
|
13142
|
-
'platform-start': VoidCall;
|
|
13143
|
-
'platform-start-from-manifest': VoidCall;
|
|
13144
13234
|
'platform-get-client': ApplicationIdentityCall<{}, void>;
|
|
13145
13235
|
'platform-create-view': ApplicationIdentityCall<{}, void>;
|
|
13146
13236
|
'platform-create-window': ApplicationIdentityCall<{}, void>;
|
|
@@ -13153,11 +13243,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13153
13243
|
'platform-set-window-context': ApplicationIdentityCall<{}, void>;
|
|
13154
13244
|
'platform-get-window-context': ApplicationIdentityCall<{}, void>;
|
|
13155
13245
|
'platform-close-window': ApplicationIdentityCall<{}, void>;
|
|
13156
|
-
'layout-wrap': VoidCall;
|
|
13157
|
-
'layout-wrap-sync': VoidCall;
|
|
13158
|
-
'layout-get-current': VoidCall;
|
|
13159
|
-
'layout-get-current-sync': VoidCall;
|
|
13160
|
-
'layout-init': VoidCall;
|
|
13161
13246
|
'layout-get-config': VoidCall;
|
|
13162
13247
|
'layout-get-views': VoidCall;
|
|
13163
13248
|
'layout-replace': VoidCall;
|
|
@@ -13176,12 +13261,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13176
13261
|
'layout-controller-create-adjacent-stack': VoidCall;
|
|
13177
13262
|
'layout-controller-get-adjacent-stacks': VoidCall;
|
|
13178
13263
|
'layout-controller-set-stack-active-view': VoidCall;
|
|
13179
|
-
'snapshot-source-init': VoidCall;
|
|
13180
|
-
'snapshot-source-wrap-sync': VoidCall;
|
|
13181
|
-
'snapshot-source-wrap': VoidCall;
|
|
13182
|
-
'snapshot-source-ready': VoidCall;
|
|
13183
|
-
'snapshot-source-get-snapshot': VoidCall;
|
|
13184
|
-
'snapshot-source-apply-snapshot': VoidCall;
|
|
13185
13264
|
'capture-page': IdentityCall<{
|
|
13186
13265
|
options?: OpenFin_2.CapturePageOptions;
|
|
13187
13266
|
}, string>;
|
|
@@ -13262,15 +13341,27 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13262
13341
|
};
|
|
13263
13342
|
response: void;
|
|
13264
13343
|
};
|
|
13265
|
-
|
|
13266
|
-
|
|
13267
|
-
|
|
13268
|
-
|
|
13269
|
-
|
|
13270
|
-
|
|
13271
|
-
|
|
13344
|
+
'subscribe-to-desktop-event': {
|
|
13345
|
+
request: {
|
|
13346
|
+
topic: string;
|
|
13347
|
+
type: string;
|
|
13348
|
+
uuid?: string;
|
|
13349
|
+
name?: string;
|
|
13350
|
+
timestamp?: number;
|
|
13351
|
+
};
|
|
13352
|
+
response: void;
|
|
13272
13353
|
};
|
|
13273
|
-
|
|
13354
|
+
'unsubscribe-to-desktop-event': {
|
|
13355
|
+
request: {
|
|
13356
|
+
topic: string;
|
|
13357
|
+
type: string;
|
|
13358
|
+
uuid?: string;
|
|
13359
|
+
name?: string;
|
|
13360
|
+
timestamp?: number;
|
|
13361
|
+
};
|
|
13362
|
+
response: void;
|
|
13363
|
+
};
|
|
13364
|
+
};
|
|
13274
13365
|
|
|
13275
13366
|
declare type ProtocolOffer = ClassicProtocolOffer | RTCProtocolOffer;
|
|
13276
13367
|
|
|
@@ -13836,7 +13927,9 @@ declare type SecurityRealmEvent = BaseEvent_9 & {
|
|
|
13836
13927
|
|
|
13837
13928
|
declare type SendActionResponse<T extends keyof ProtocolMap> = Message<{
|
|
13838
13929
|
data: ProtocolMap[T]['response'];
|
|
13839
|
-
} & ProtocolMap[T]
|
|
13930
|
+
} & (ProtocolMap[T] extends {
|
|
13931
|
+
specialResponse: infer U;
|
|
13932
|
+
} ? U : {})>;
|
|
13840
13933
|
|
|
13841
13934
|
/**
|
|
13842
13935
|
* @interface
|
|
@@ -14351,13 +14444,15 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
14351
14444
|
* * cookies: browser [cookies](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies)
|
|
14352
14445
|
* * localStorage: browser data that can be used across sessions ([local storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage))
|
|
14353
14446
|
* * appcache: html5 [application cache](https://developer.mozilla.org/en-US/docs/Web/HTML/Using_the_application_cache)
|
|
14447
|
+
* * windowState: clears data written for windows using `saveWindowState`; after clearing, previously saved bounds and state will not be restored until new state is written
|
|
14354
14448
|
* @example
|
|
14355
14449
|
* ```js
|
|
14356
14450
|
* const clearCacheOptions = {
|
|
14357
14451
|
* appcache: true,
|
|
14358
14452
|
* cache: true,
|
|
14359
14453
|
* cookies: true,
|
|
14360
|
-
* localStorage: true
|
|
14454
|
+
* localStorage: true,
|
|
14455
|
+
* windowState: true
|
|
14361
14456
|
* };
|
|
14362
14457
|
* fin.System.clearCache(clearCacheOptions).then(() => console.log('Cache cleared')).catch(err => console.log(err));
|
|
14363
14458
|
* ```
|
|
@@ -15855,7 +15950,6 @@ declare type SystemEventType = EventType_8;
|
|
|
15855
15950
|
*/
|
|
15856
15951
|
declare type SystemPermissions = {
|
|
15857
15952
|
getOSInfo: boolean;
|
|
15858
|
-
getAllExternalWindows: boolean;
|
|
15859
15953
|
setDomainSettings: boolean;
|
|
15860
15954
|
getDomainSettings: boolean;
|
|
15861
15955
|
getCurrentDomainSettings: boolean;
|
|
@@ -15895,6 +15989,10 @@ declare type SystemPermissions = {
|
|
|
15895
15989
|
enabled: boolean;
|
|
15896
15990
|
protocols: string[];
|
|
15897
15991
|
};
|
|
15992
|
+
getInstalledApps: boolean;
|
|
15993
|
+
downloadAsset: boolean;
|
|
15994
|
+
serveAsset: boolean;
|
|
15995
|
+
enableNativeWindowIntegrationProvider: boolean;
|
|
15898
15996
|
};
|
|
15899
15997
|
|
|
15900
15998
|
/**
|
|
@@ -16203,9 +16301,12 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
|
|
|
16203
16301
|
sendRaw: Wire['send'];
|
|
16204
16302
|
eventAggregator: EventAggregator;
|
|
16205
16303
|
protected messageHandlers: MessageHandler[];
|
|
16206
|
-
constructor(factory: WireFactory, environment: Environment, config: OpenFin_2.Identity
|
|
16304
|
+
constructor(factory: WireFactory, environment: Environment, config: OpenFin_2.Identity & {
|
|
16305
|
+
apiDiagnostics?: boolean;
|
|
16306
|
+
});
|
|
16207
16307
|
getFin(): OpenFin_2.Fin<MeType>;
|
|
16208
16308
|
registerFin(_fin: OpenFin_2.Fin<MeType>): void;
|
|
16309
|
+
recordAnalytic(action: string): void;
|
|
16209
16310
|
connectSync: () => void;
|
|
16210
16311
|
getPort: () => string;
|
|
16211
16312
|
shutdown(): Promise<void>;
|
|
@@ -16213,7 +16314,7 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
|
|
|
16213
16314
|
private connectRemote;
|
|
16214
16315
|
connectByPort(config: ExistingConnectConfig): Promise<void>;
|
|
16215
16316
|
private authorize;
|
|
16216
|
-
sendAction<T extends keyof ProtocolMap
|
|
16317
|
+
sendAction<T extends keyof ProtocolMap>(action: T, payload?: ProtocolMap[T]['request'], uncorrelated?: boolean): SentMessage<SendActionResponse<T>>;
|
|
16217
16318
|
protected nackHandler(payloadOrMessage: RuntimeErrorPayload | string, reject: Function, callSites?: NodeJS.CallSite[]): void;
|
|
16218
16319
|
ferryAction(origData: any): Promise<Message<any>>;
|
|
16219
16320
|
registerMessageHandler(handler: MessageHandler): void;
|