@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/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;
|
|
@@ -2827,7 +2834,7 @@ declare class ChannelProvider extends ChannelBase {
|
|
|
2827
2834
|
* a read-only array containing all the identities of connecting clients.
|
|
2828
2835
|
*/
|
|
2829
2836
|
get connections(): OpenFin_2.ClientConnectionPayload[];
|
|
2830
|
-
static handleClientDisconnection(channel: ChannelProvider, payload:
|
|
2837
|
+
static handleClientDisconnection(channel: ChannelProvider, payload: ClientDisconnectionPayload): void;
|
|
2831
2838
|
static setProviderRemoval(provider: ChannelProvider, remove: Function): void;
|
|
2832
2839
|
/**
|
|
2833
2840
|
* @internal
|
|
@@ -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
|
/**
|
|
@@ -3109,6 +3121,10 @@ declare type ClickedMenuResult<Data extends unknown = unknown> = {
|
|
|
3109
3121
|
*/
|
|
3110
3122
|
declare type ClientConnectionPayload = ClientIdentity & ClientInfo;
|
|
3111
3123
|
|
|
3124
|
+
declare type ClientDisconnectionPayload = OpenFin_2.Identity & {
|
|
3125
|
+
endpointId?: string;
|
|
3126
|
+
};
|
|
3127
|
+
|
|
3112
3128
|
/**
|
|
3113
3129
|
* Identity of a channel client. Includes endpointId to differentiate between different connections for an entity.
|
|
3114
3130
|
* @interface
|
|
@@ -3314,6 +3330,7 @@ declare type ClipboardApiPermissions = {
|
|
|
3314
3330
|
writeRtf: boolean;
|
|
3315
3331
|
readRtf: boolean;
|
|
3316
3332
|
write: boolean;
|
|
3333
|
+
setClipboard: boolean;
|
|
3317
3334
|
};
|
|
3318
3335
|
|
|
3319
3336
|
/**
|
|
@@ -4837,20 +4854,11 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
|
|
|
4837
4854
|
type: EventType;
|
|
4838
4855
|
}>, ...args: any[]) => boolean;
|
|
4839
4856
|
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
4857
|
private getOrCreateEmitter;
|
|
4850
4858
|
listeners: (type: string | symbol) => Function[];
|
|
4851
4859
|
listenerCount: (type: string | symbol) => number;
|
|
4852
4860
|
protected registerEventListener: (eventType: EmitterEventType, options: OpenFin_2.SubscriptionOptions | undefined, applySubscription: (emitter: EventEmitter) => void, undoSubscription: (emitter: EventEmitter) => void) => Promise<void>;
|
|
4853
|
-
|
|
4861
|
+
private deregisterEventListener;
|
|
4854
4862
|
/**
|
|
4855
4863
|
* Adds a listener to the end of the listeners array for the specified event.
|
|
4856
4864
|
*
|
|
@@ -4886,7 +4894,7 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
|
|
|
4886
4894
|
* @remarks Caution: Calling this method changes the array indices in the listener array behind the listener.
|
|
4887
4895
|
*/
|
|
4888
4896
|
removeListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin_2.SubscriptionOptions): Promise<this>;
|
|
4889
|
-
|
|
4897
|
+
private deregisterAllListeners;
|
|
4890
4898
|
/**
|
|
4891
4899
|
* Removes all listeners, or those of the specified event.
|
|
4892
4900
|
*
|
|
@@ -5335,6 +5343,19 @@ declare type ExtensionsInstallFailedEvent = ExtensionsEvent & {
|
|
|
5335
5343
|
type: 'extensions-install-failed';
|
|
5336
5344
|
};
|
|
5337
5345
|
|
|
5346
|
+
/**
|
|
5347
|
+
* these api calls are not implemented in the javscript api, only in the external adapter
|
|
5348
|
+
* If they don't exist in the external adapter they should be removed.
|
|
5349
|
+
*/
|
|
5350
|
+
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';
|
|
5351
|
+
|
|
5352
|
+
declare type ExternalAdapterOnlyCallsMap = {
|
|
5353
|
+
[k in ExternalAdapterOnlyCalls]: {
|
|
5354
|
+
request: any;
|
|
5355
|
+
response: any;
|
|
5356
|
+
};
|
|
5357
|
+
};
|
|
5358
|
+
|
|
5338
5359
|
/**
|
|
5339
5360
|
* An ExternalApplication object representing native language adapter connections to the runtime. Allows
|
|
5340
5361
|
* the developer to listen to {@link OpenFin.ExternalApplicationEvents external application events}.
|
|
@@ -6479,6 +6500,16 @@ declare type IntentMetadata<TargetType = any> = {
|
|
|
6479
6500
|
*/
|
|
6480
6501
|
declare class InterApplicationBus extends Base {
|
|
6481
6502
|
Channel: Channel;
|
|
6503
|
+
/**
|
|
6504
|
+
* Event types for the InterApplicationBus.
|
|
6505
|
+
*
|
|
6506
|
+
* @remarks The `subscriber-added` and `subscriber-removed` events are disabled by default.
|
|
6507
|
+
* To re-enable them, launch the runtime with the `--emit-legacy-iab-events` flag.
|
|
6508
|
+
* These events will be removed in a future version. Use {@link Channel} for connection
|
|
6509
|
+
* lifecycle management instead.
|
|
6510
|
+
*
|
|
6511
|
+
* @deprecated Use {@link Channel} `onConnection` / `onDisconnection` instead.
|
|
6512
|
+
*/
|
|
6482
6513
|
events: {
|
|
6483
6514
|
subscriberAdded: string;
|
|
6484
6515
|
subscriberRemoved: string;
|
|
@@ -9516,11 +9547,11 @@ declare type MutableWindowOptions = {
|
|
|
9516
9547
|
*/
|
|
9517
9548
|
customData: any;
|
|
9518
9549
|
/**
|
|
9519
|
-
* @deprecated Will be removed in runtime version 45
|
|
9520
|
-
* @defaultValue true
|
|
9521
|
-
*
|
|
9522
9550
|
* Show the window's frame.
|
|
9523
9551
|
*
|
|
9552
|
+
* @remarks
|
|
9553
|
+
* This property will not be updatable starting runtime version 45.
|
|
9554
|
+
*
|
|
9524
9555
|
* @default true
|
|
9525
9556
|
*/
|
|
9526
9557
|
frame: boolean;
|
|
@@ -9861,6 +9892,8 @@ declare namespace OpenFin_2 {
|
|
|
9861
9892
|
TabStack,
|
|
9862
9893
|
_Window as Window,
|
|
9863
9894
|
_WindowModule,
|
|
9895
|
+
Clipboard_2 as Clipboard,
|
|
9896
|
+
InterApplicationBus,
|
|
9864
9897
|
InteropClient,
|
|
9865
9898
|
InteropBroker,
|
|
9866
9899
|
InteropModule,
|
|
@@ -12542,7 +12575,7 @@ declare type PropagatedWindowEvent<TargetTopic extends string> = PropagatedEvent
|
|
|
12542
12575
|
*/
|
|
12543
12576
|
declare type PropagatedWindowEventType = PropagatedEvent_3<string>['type'];
|
|
12544
12577
|
|
|
12545
|
-
declare
|
|
12578
|
+
declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap & {
|
|
12546
12579
|
'is-application-running': ApplicationIdentityCall<{}, boolean>;
|
|
12547
12580
|
'destroy-application': ApplicationIdentityCall<{
|
|
12548
12581
|
force: boolean;
|
|
@@ -12609,8 +12642,15 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12609
12642
|
downloadLocation: string;
|
|
12610
12643
|
};
|
|
12611
12644
|
response: void;
|
|
12645
|
+
secure: true;
|
|
12646
|
+
namespace: 'Application';
|
|
12647
|
+
apiPath: '.setFileDownloadLocation';
|
|
12648
|
+
};
|
|
12649
|
+
'get-file-download-location': ApplicationIdentityCall<{}, string> & {
|
|
12650
|
+
secure: true;
|
|
12651
|
+
namespace: 'Application';
|
|
12652
|
+
apiPath: '.getFileDownloadLocation';
|
|
12612
12653
|
};
|
|
12613
|
-
'get-file-download-location': ApplicationIdentityCall<{}, string>;
|
|
12614
12654
|
'show-tray-icon-popup-menu': {
|
|
12615
12655
|
request: OpenFin_2.Identity & {
|
|
12616
12656
|
options: OpenFin_2.ShowTrayIconPopupMenuOptions;
|
|
@@ -12618,19 +12658,17 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12618
12658
|
response: OpenFin_2.MenuResult;
|
|
12619
12659
|
};
|
|
12620
12660
|
'close-tray-icon-popup-menu': IdentityCall<{}, void>;
|
|
12621
|
-
'wrap-application': VoidCall;
|
|
12622
|
-
'wrap-application-sync': VoidCall;
|
|
12623
12661
|
'create-application': ApiCall<OpenFin_2.ApplicationCreationOptions, void>;
|
|
12624
|
-
'application-create': VoidCall;
|
|
12625
|
-
'start-application': VoidCall;
|
|
12626
12662
|
'run-applications': ApiCall<{
|
|
12627
12663
|
applications: Array<OpenFin_2.ManifestInfo>;
|
|
12628
12664
|
opts?: OpenFin_2.RvmLaunchOptions;
|
|
12629
12665
|
}, void>;
|
|
12630
|
-
'
|
|
12631
|
-
|
|
12632
|
-
|
|
12633
|
-
|
|
12666
|
+
'send-analytics-batch': {
|
|
12667
|
+
request: {
|
|
12668
|
+
counts: Record<string, number>;
|
|
12669
|
+
};
|
|
12670
|
+
response: void;
|
|
12671
|
+
};
|
|
12634
12672
|
'request-external-authorization': {
|
|
12635
12673
|
request: any;
|
|
12636
12674
|
response: void;
|
|
@@ -12650,44 +12688,69 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12650
12688
|
'clipboard-read-image': {
|
|
12651
12689
|
request: OpenFin_2.ReadImageClipboardRequest;
|
|
12652
12690
|
response: string;
|
|
12691
|
+
apiPath: '.readImage';
|
|
12692
|
+
namespace: 'Clipboard';
|
|
12653
12693
|
};
|
|
12654
12694
|
'clipboard-read-text': {
|
|
12655
12695
|
request: {
|
|
12656
12696
|
type?: OpenFin_2.ClipboardSelectionType;
|
|
12657
12697
|
};
|
|
12658
12698
|
response: string;
|
|
12699
|
+
apiPath: '.readText';
|
|
12700
|
+
namespace: 'Clipboard';
|
|
12659
12701
|
};
|
|
12660
12702
|
'clipboard-read-html': {
|
|
12661
12703
|
request: {
|
|
12662
12704
|
type?: OpenFin_2.ClipboardSelectionType;
|
|
12663
12705
|
};
|
|
12664
12706
|
response: string;
|
|
12707
|
+
apiPath: '.readHtml';
|
|
12708
|
+
namespace: 'Clipboard';
|
|
12665
12709
|
};
|
|
12666
12710
|
'clipboard-read-rtf': {
|
|
12667
12711
|
request: {
|
|
12668
12712
|
type?: OpenFin_2.ClipboardSelectionType;
|
|
12669
12713
|
};
|
|
12670
12714
|
response: string;
|
|
12715
|
+
apiPath: '.readRtf';
|
|
12716
|
+
namespace: 'Clipboard';
|
|
12671
12717
|
};
|
|
12672
12718
|
'clipboard-write-image': {
|
|
12673
12719
|
request: OpenFin_2.WriteImageClipboardRequest;
|
|
12674
12720
|
response: void;
|
|
12721
|
+
apiPath: '.writeImage';
|
|
12722
|
+
namespace: 'Clipboard';
|
|
12675
12723
|
};
|
|
12676
12724
|
'clipboard-write': {
|
|
12677
12725
|
request: OpenFin_2.WriteAnyRequestType;
|
|
12678
12726
|
response: void;
|
|
12727
|
+
apiPath: '.write';
|
|
12728
|
+
namespace: 'Clipboard';
|
|
12679
12729
|
};
|
|
12680
12730
|
'clipboard-write-text': {
|
|
12681
12731
|
request: OpenFin_2.WriteClipboardRequest;
|
|
12682
12732
|
response: void;
|
|
12733
|
+
apiPath: '.writeText';
|
|
12734
|
+
namespace: 'Clipboard';
|
|
12735
|
+
foo: '';
|
|
12736
|
+
};
|
|
12737
|
+
'set-clipboard': {
|
|
12738
|
+
request: OpenFin_2.WriteClipboardRequest;
|
|
12739
|
+
response: void;
|
|
12740
|
+
apiPath: '.setClipboard';
|
|
12741
|
+
namespace: 'Clipboard';
|
|
12683
12742
|
};
|
|
12684
12743
|
'clipboard-write-html': {
|
|
12685
12744
|
request: OpenFin_2.WriteClipboardRequest;
|
|
12686
12745
|
response: void;
|
|
12746
|
+
apiPath: '.writeHtml';
|
|
12747
|
+
namespace: 'Clipboard';
|
|
12687
12748
|
};
|
|
12688
12749
|
'clipboard-write-rtf': {
|
|
12689
12750
|
request: OpenFin_2.WriteClipboardRequest;
|
|
12690
12751
|
response: void;
|
|
12752
|
+
apiPath: '.writeRtf';
|
|
12753
|
+
namespace: 'Clipboard';
|
|
12691
12754
|
};
|
|
12692
12755
|
'get-view-window': IdentityCall<{}, OpenFin_2.Identity>;
|
|
12693
12756
|
'create-view': IdentityCall<OpenFin_2.ViewCreationOptions & {
|
|
@@ -12714,18 +12777,10 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12714
12777
|
options: OpenFin_2.UpdatableViewOptions;
|
|
12715
12778
|
}>;
|
|
12716
12779
|
'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
12780
|
'animate-window': IdentityCall<{
|
|
12722
12781
|
transitions: OpenFin_2.Transition;
|
|
12723
12782
|
options: OpenFin_2.TransitionOptions;
|
|
12724
12783
|
}>;
|
|
12725
|
-
'activate-window-and-focus': ApiCall<{
|
|
12726
|
-
winIdentity: OpenFin_2.Identity;
|
|
12727
|
-
focusIdentity: OpenFin_2.Identity;
|
|
12728
|
-
}, boolean>;
|
|
12729
12784
|
'get-all-frames': IdentityCall<{}, OpenFin_2.FrameInfo[]>;
|
|
12730
12785
|
'get-window-bounds': IdentityCall<{
|
|
12731
12786
|
options?: OpenFin_2.GetBoundsOptions;
|
|
@@ -12814,15 +12869,13 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12814
12869
|
'create-window': VoidCall;
|
|
12815
12870
|
'get-current-window': VoidCall;
|
|
12816
12871
|
'get-current-window-sync': VoidCall;
|
|
12872
|
+
'activate-window-and-focus': ApiCall<{
|
|
12873
|
+
winIdentity: OpenFin_2.Identity;
|
|
12874
|
+
focusIdentity: OpenFin_2.Identity;
|
|
12875
|
+
}, boolean>;
|
|
12817
12876
|
'get-external-application-info': ApiCall<OpenFin_2.ApplicationIdentity, OpenFin_2.ExternalApplicationInfo>;
|
|
12818
|
-
'external-application-wrap': VoidCall;
|
|
12819
|
-
'external-application-wrap-sync': VoidCall;
|
|
12820
12877
|
'get-frame-info': ApiCall<OpenFin_2.Identity, OpenFin_2.FrameInfo>;
|
|
12821
12878
|
'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
12879
|
'global-hotkey-register': {
|
|
12827
12880
|
request: {
|
|
12828
12881
|
hotkey: string;
|
|
@@ -12906,6 +12959,10 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12906
12959
|
request: any;
|
|
12907
12960
|
response: any;
|
|
12908
12961
|
};
|
|
12962
|
+
'send-channel-result': {
|
|
12963
|
+
request: any;
|
|
12964
|
+
response: any;
|
|
12965
|
+
};
|
|
12909
12966
|
'get-version': GetterCall<string>;
|
|
12910
12967
|
'clear-cache': ApiCall<OpenFin_2.ClearCacheOption, void>;
|
|
12911
12968
|
'delete-cache-request': VoidCall;
|
|
@@ -12955,7 +13012,11 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12955
13012
|
action: string;
|
|
12956
13013
|
runtimes: string[];
|
|
12957
13014
|
}>;
|
|
12958
|
-
'get-installed-apps': GetterCall<OpenFin_2.InstalledApps
|
|
13015
|
+
'get-installed-apps': GetterCall<OpenFin_2.InstalledApps> & {
|
|
13016
|
+
secure: true;
|
|
13017
|
+
apiPath: '.getInstalledApps';
|
|
13018
|
+
namespace: 'System';
|
|
13019
|
+
};
|
|
12959
13020
|
'view-log': ApiCall<OpenFin_2.GetLogRequestType, string>;
|
|
12960
13021
|
'get-machine-id': GetterCall<string>;
|
|
12961
13022
|
'get-min-log-level': GetterCall<OpenFin_2.LogLevel>;
|
|
@@ -12968,8 +13029,16 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12968
13029
|
'get-runtime-info': GetterCall<OpenFin_2.RuntimeInfo>;
|
|
12969
13030
|
'get-rvm-info': GetterCall<OpenFin_2.RVMInfo>;
|
|
12970
13031
|
'get-host-specs': GetterCall<OpenFin_2.HostSpecs>;
|
|
12971
|
-
'get-os-info': GetterCall<OpenFin_2.OSInfo
|
|
12972
|
-
|
|
13032
|
+
'get-os-info': GetterCall<OpenFin_2.OSInfo> & {
|
|
13033
|
+
secure: true;
|
|
13034
|
+
apiPath: '.getOSInfo';
|
|
13035
|
+
namespace: 'System';
|
|
13036
|
+
};
|
|
13037
|
+
'launch-external-process': ApiCall<OpenFin_2.ExternalProcessRequestType, OpenFin_2.Identity> & {
|
|
13038
|
+
secure: true;
|
|
13039
|
+
apiPath: '.launchExternalProcess';
|
|
13040
|
+
namespace: 'System';
|
|
13041
|
+
};
|
|
12973
13042
|
'monitor-external-process': ApiCall<OpenFin_2.ExternalProcessInfo, OpenFin_2.Identity>;
|
|
12974
13043
|
'write-to-log': ApiCall<{
|
|
12975
13044
|
level: string;
|
|
@@ -12977,25 +13046,48 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12977
13046
|
}, void>;
|
|
12978
13047
|
'open-url-with-browser': ApiCall<{
|
|
12979
13048
|
url: string;
|
|
12980
|
-
}, void
|
|
12981
|
-
|
|
13049
|
+
}, void> & {
|
|
13050
|
+
secure: true;
|
|
13051
|
+
apiPath: '.openUrlWithBrowser';
|
|
13052
|
+
namespace: 'System';
|
|
13053
|
+
};
|
|
13054
|
+
'register-custom-protocol': ApiCall<OpenFin_2.CustomProtocolOptions, void> & {
|
|
13055
|
+
secure: true;
|
|
13056
|
+
apiPath: '.registerCustomProtocol';
|
|
13057
|
+
namespace: 'System';
|
|
13058
|
+
};
|
|
12982
13059
|
'unregister-custom-protocol': ApiCall<{
|
|
12983
13060
|
protocolName: string;
|
|
12984
|
-
}, void
|
|
13061
|
+
}, void> & {
|
|
13062
|
+
secure: true;
|
|
13063
|
+
apiPath: '.unregisterCustomProtocol';
|
|
13064
|
+
namespace: 'System';
|
|
13065
|
+
};
|
|
12985
13066
|
'get-custom-protocol-state': ApiCall<{
|
|
12986
13067
|
protocolName: string;
|
|
12987
|
-
}, OpenFin_2.CustomProtocolState
|
|
13068
|
+
}, OpenFin_2.CustomProtocolState> & {
|
|
13069
|
+
secure: true;
|
|
13070
|
+
apiPath: '.getCustomProtocolState';
|
|
13071
|
+
namespace: 'System';
|
|
13072
|
+
};
|
|
12988
13073
|
'release-external-process': ApiCall<{
|
|
12989
13074
|
uuid: string;
|
|
12990
13075
|
}, void>;
|
|
12991
13076
|
'show-developer-tools': ApiCall<OpenFin_2.Identity, void>;
|
|
12992
|
-
'terminate-external-process': ApiCall<OpenFin_2.TerminateExternalRequestType, void
|
|
13077
|
+
'terminate-external-process': ApiCall<OpenFin_2.TerminateExternalRequestType, void> & {
|
|
13078
|
+
secure: true;
|
|
13079
|
+
apiPath: '.terminateExternalProcess';
|
|
13080
|
+
namespace: 'System';
|
|
13081
|
+
};
|
|
12993
13082
|
'update-proxy': ApiCall<OpenFin_2.ProxyConfig, void>;
|
|
12994
13083
|
'download-asset': {
|
|
12995
13084
|
request: OpenFin_2.AppAssetInfo & {
|
|
12996
13085
|
downloadId: string;
|
|
12997
13086
|
};
|
|
12998
13087
|
response: void;
|
|
13088
|
+
secure: true;
|
|
13089
|
+
apiPath: '.downloadAsset';
|
|
13090
|
+
namespace: 'System';
|
|
12999
13091
|
};
|
|
13000
13092
|
'download-runtime': {
|
|
13001
13093
|
request: OpenFin_2.RuntimeDownloadOptions & {
|
|
@@ -13024,7 +13116,11 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13024
13116
|
rootKey: string;
|
|
13025
13117
|
subkey: string;
|
|
13026
13118
|
value: string;
|
|
13027
|
-
}, OpenFin_2.RegistryInfo
|
|
13119
|
+
}, OpenFin_2.RegistryInfo> & {
|
|
13120
|
+
secure: true;
|
|
13121
|
+
apiPath: '.readRegistryValue';
|
|
13122
|
+
namespace: 'System';
|
|
13123
|
+
};
|
|
13028
13124
|
'register-external-connection': ApiCall<{
|
|
13029
13125
|
uuid: string;
|
|
13030
13126
|
}, OpenFin_2.ExternalConnection>;
|
|
@@ -13058,26 +13154,48 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13058
13154
|
permissions: any;
|
|
13059
13155
|
};
|
|
13060
13156
|
response: OpenFin_2.NativeWindowIntegrationProviderAuthorization;
|
|
13157
|
+
secure: true;
|
|
13158
|
+
apiPath: '.enableNativeWindowIntegrationProvider';
|
|
13159
|
+
namespace: 'System';
|
|
13061
13160
|
};
|
|
13062
13161
|
'register-usage': ApiCall<OpenFin_2.RegisterUsageData, void>;
|
|
13063
13162
|
'system-get-printers': GetterCall<OpenFin_2.PrinterInfo[]>;
|
|
13064
13163
|
'system-update-process-logging-options': ApiCall<{
|
|
13065
13164
|
options: OpenFin_2.ProcessLoggingOptions;
|
|
13066
13165
|
}, void>;
|
|
13067
|
-
'get-domain-settings': ApiCall<void, OpenFin_2.DomainSettings
|
|
13166
|
+
'get-domain-settings': ApiCall<void, OpenFin_2.DomainSettings> & {
|
|
13167
|
+
secure: true;
|
|
13168
|
+
apiPath: '.getDomainSettings';
|
|
13169
|
+
namespace: 'System';
|
|
13170
|
+
};
|
|
13068
13171
|
'serve-asset': ApiCall<{
|
|
13069
13172
|
options: OpenFin_2.ServeAssetOptions;
|
|
13070
|
-
}, OpenFin_2.ServedAssetInfo
|
|
13173
|
+
}, OpenFin_2.ServedAssetInfo> & {
|
|
13174
|
+
secure: true;
|
|
13175
|
+
apiPath: '.serveAsset';
|
|
13176
|
+
namespace: 'System';
|
|
13177
|
+
};
|
|
13071
13178
|
'set-domain-settings': ApiCall<{
|
|
13072
13179
|
domainSettings: OpenFin_2.DomainSettings;
|
|
13073
|
-
}, void
|
|
13180
|
+
}, void> & {
|
|
13181
|
+
secure: true;
|
|
13182
|
+
apiPath: '.setDomainSettings';
|
|
13183
|
+
namespace: 'System';
|
|
13184
|
+
};
|
|
13074
13185
|
'get-current-domain-settings': ApiCall<{
|
|
13075
13186
|
identity: OpenFin_2.Identity;
|
|
13076
|
-
}, OpenFin_2.ResolvedDomainSettings
|
|
13187
|
+
}, OpenFin_2.ResolvedDomainSettings> & {
|
|
13188
|
+
secure: true;
|
|
13189
|
+
apiPath: '.getCurrentDomainSettings';
|
|
13190
|
+
namespace: 'System';
|
|
13191
|
+
};
|
|
13077
13192
|
'resolve-domain-settings': ApiCall<{
|
|
13078
13193
|
url: string;
|
|
13079
|
-
}, OpenFin_2.ResolvedDomainSettings
|
|
13080
|
-
|
|
13194
|
+
}, OpenFin_2.ResolvedDomainSettings> & {
|
|
13195
|
+
secure: true;
|
|
13196
|
+
apiPath: '.resolveDomainSettings';
|
|
13197
|
+
namespace: 'System';
|
|
13198
|
+
};
|
|
13081
13199
|
'get-permissions': GetterCall<any>;
|
|
13082
13200
|
'refresh-extensions': {
|
|
13083
13201
|
request: void;
|
|
@@ -13087,24 +13205,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13087
13205
|
request: void;
|
|
13088
13206
|
response: OpenFin_2.ExtensionInfo[];
|
|
13089
13207
|
};
|
|
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
13208
|
'interop-client-set-context': VoidCall;
|
|
13109
13209
|
'interop-client-add-context-handler': VoidCall;
|
|
13110
13210
|
'interop-client-get-context-groups': VoidCall;
|
|
@@ -13135,12 +13235,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13135
13235
|
'interop-session-context-group-set-context': VoidCall;
|
|
13136
13236
|
'interop-session-context-group-get-context': VoidCall;
|
|
13137
13237
|
'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
13238
|
'platform-get-client': ApplicationIdentityCall<{}, void>;
|
|
13145
13239
|
'platform-create-view': ApplicationIdentityCall<{}, void>;
|
|
13146
13240
|
'platform-create-window': ApplicationIdentityCall<{}, void>;
|
|
@@ -13153,11 +13247,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13153
13247
|
'platform-set-window-context': ApplicationIdentityCall<{}, void>;
|
|
13154
13248
|
'platform-get-window-context': ApplicationIdentityCall<{}, void>;
|
|
13155
13249
|
'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
13250
|
'layout-get-config': VoidCall;
|
|
13162
13251
|
'layout-get-views': VoidCall;
|
|
13163
13252
|
'layout-replace': VoidCall;
|
|
@@ -13176,12 +13265,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13176
13265
|
'layout-controller-create-adjacent-stack': VoidCall;
|
|
13177
13266
|
'layout-controller-get-adjacent-stacks': VoidCall;
|
|
13178
13267
|
'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
13268
|
'capture-page': IdentityCall<{
|
|
13186
13269
|
options?: OpenFin_2.CapturePageOptions;
|
|
13187
13270
|
}, string>;
|
|
@@ -13262,15 +13345,27 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13262
13345
|
};
|
|
13263
13346
|
response: void;
|
|
13264
13347
|
};
|
|
13265
|
-
|
|
13266
|
-
|
|
13267
|
-
|
|
13268
|
-
|
|
13269
|
-
|
|
13270
|
-
|
|
13271
|
-
|
|
13348
|
+
'subscribe-to-desktop-event': {
|
|
13349
|
+
request: {
|
|
13350
|
+
topic: string;
|
|
13351
|
+
type: string;
|
|
13352
|
+
uuid?: string;
|
|
13353
|
+
name?: string;
|
|
13354
|
+
timestamp?: number;
|
|
13355
|
+
};
|
|
13356
|
+
response: void;
|
|
13272
13357
|
};
|
|
13273
|
-
|
|
13358
|
+
'unsubscribe-to-desktop-event': {
|
|
13359
|
+
request: {
|
|
13360
|
+
topic: string;
|
|
13361
|
+
type: string;
|
|
13362
|
+
uuid?: string;
|
|
13363
|
+
name?: string;
|
|
13364
|
+
timestamp?: number;
|
|
13365
|
+
};
|
|
13366
|
+
response: void;
|
|
13367
|
+
};
|
|
13368
|
+
};
|
|
13274
13369
|
|
|
13275
13370
|
declare type ProtocolOffer = ClassicProtocolOffer | RTCProtocolOffer;
|
|
13276
13371
|
|
|
@@ -13836,7 +13931,9 @@ declare type SecurityRealmEvent = BaseEvent_9 & {
|
|
|
13836
13931
|
|
|
13837
13932
|
declare type SendActionResponse<T extends keyof ProtocolMap> = Message<{
|
|
13838
13933
|
data: ProtocolMap[T]['response'];
|
|
13839
|
-
} & ProtocolMap[T]
|
|
13934
|
+
} & (ProtocolMap[T] extends {
|
|
13935
|
+
specialResponse: infer U;
|
|
13936
|
+
} ? U : {})>;
|
|
13840
13937
|
|
|
13841
13938
|
/**
|
|
13842
13939
|
* @interface
|
|
@@ -14351,13 +14448,15 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
14351
14448
|
* * cookies: browser [cookies](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies)
|
|
14352
14449
|
* * localStorage: browser data that can be used across sessions ([local storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage))
|
|
14353
14450
|
* * appcache: html5 [application cache](https://developer.mozilla.org/en-US/docs/Web/HTML/Using_the_application_cache)
|
|
14451
|
+
* * 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
14452
|
* @example
|
|
14355
14453
|
* ```js
|
|
14356
14454
|
* const clearCacheOptions = {
|
|
14357
14455
|
* appcache: true,
|
|
14358
14456
|
* cache: true,
|
|
14359
14457
|
* cookies: true,
|
|
14360
|
-
* localStorage: true
|
|
14458
|
+
* localStorage: true,
|
|
14459
|
+
* windowState: true
|
|
14361
14460
|
* };
|
|
14362
14461
|
* fin.System.clearCache(clearCacheOptions).then(() => console.log('Cache cleared')).catch(err => console.log(err));
|
|
14363
14462
|
* ```
|
|
@@ -15855,7 +15954,6 @@ declare type SystemEventType = EventType_8;
|
|
|
15855
15954
|
*/
|
|
15856
15955
|
declare type SystemPermissions = {
|
|
15857
15956
|
getOSInfo: boolean;
|
|
15858
|
-
getAllExternalWindows: boolean;
|
|
15859
15957
|
setDomainSettings: boolean;
|
|
15860
15958
|
getDomainSettings: boolean;
|
|
15861
15959
|
getCurrentDomainSettings: boolean;
|
|
@@ -15895,6 +15993,10 @@ declare type SystemPermissions = {
|
|
|
15895
15993
|
enabled: boolean;
|
|
15896
15994
|
protocols: string[];
|
|
15897
15995
|
};
|
|
15996
|
+
getInstalledApps: boolean;
|
|
15997
|
+
downloadAsset: boolean;
|
|
15998
|
+
serveAsset: boolean;
|
|
15999
|
+
enableNativeWindowIntegrationProvider: boolean;
|
|
15898
16000
|
};
|
|
15899
16001
|
|
|
15900
16002
|
/**
|
|
@@ -16203,9 +16305,12 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
|
|
|
16203
16305
|
sendRaw: Wire['send'];
|
|
16204
16306
|
eventAggregator: EventAggregator;
|
|
16205
16307
|
protected messageHandlers: MessageHandler[];
|
|
16206
|
-
constructor(factory: WireFactory, environment: Environment, config: OpenFin_2.Identity
|
|
16308
|
+
constructor(factory: WireFactory, environment: Environment, config: OpenFin_2.Identity & {
|
|
16309
|
+
apiDiagnostics?: boolean;
|
|
16310
|
+
});
|
|
16207
16311
|
getFin(): OpenFin_2.Fin<MeType>;
|
|
16208
16312
|
registerFin(_fin: OpenFin_2.Fin<MeType>): void;
|
|
16313
|
+
recordAnalytic(action: string): void;
|
|
16209
16314
|
connectSync: () => void;
|
|
16210
16315
|
getPort: () => string;
|
|
16211
16316
|
shutdown(): Promise<void>;
|
|
@@ -16213,7 +16318,7 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
|
|
|
16213
16318
|
private connectRemote;
|
|
16214
16319
|
connectByPort(config: ExistingConnectConfig): Promise<void>;
|
|
16215
16320
|
private authorize;
|
|
16216
|
-
sendAction<T extends keyof ProtocolMap
|
|
16321
|
+
sendAction<T extends keyof ProtocolMap>(action: T, payload?: ProtocolMap[T]['request'], uncorrelated?: boolean): SentMessage<SendActionResponse<T>>;
|
|
16217
16322
|
protected nackHandler(payloadOrMessage: RuntimeErrorPayload | string, reject: Function, callSites?: NodeJS.CallSite[]): void;
|
|
16218
16323
|
ferryAction(origData: any): Promise<Message<any>>;
|
|
16219
16324
|
registerMessageHandler(handler: MessageHandler): void;
|