@openfin/fdc3-api 41.103.2 → 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/fdc3-api-alpha.d.ts +207 -102
- package/out/fdc3-api-beta.d.ts +207 -102
- package/out/fdc3-api-public.d.ts +207 -102
- package/out/fdc3-api.d.ts +207 -102
- package/out/fdc3-api.js +32 -132
- package/package.json +29 -24
package/out/fdc3-api-beta.d.ts
CHANGED
|
@@ -85,6 +85,12 @@ declare type AlertRequestedEvent = BaseEvent_5 & {
|
|
|
85
85
|
url: string;
|
|
86
86
|
};
|
|
87
87
|
|
|
88
|
+
declare type AnalyticsOnlyCalls = 'layout-get-stack-by-view' | 'layout-add-view' | 'layout-close-view' | `layout-controller-${string}`;
|
|
89
|
+
|
|
90
|
+
declare type AnalyticsProtocolMap = {
|
|
91
|
+
[k in AnalyticsOnlyCalls]: VoidCall;
|
|
92
|
+
};
|
|
93
|
+
|
|
88
94
|
declare type AnchorType = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
|
|
89
95
|
|
|
90
96
|
declare type AnyStrategy = ChannelStrategy<any>;
|
|
@@ -1673,6 +1679,7 @@ declare type BaseConfig = {
|
|
|
1673
1679
|
devToolsPort?: number;
|
|
1674
1680
|
installerUI?: boolean;
|
|
1675
1681
|
runtime?: RuntimeConfig;
|
|
1682
|
+
apiDiagnostics?: boolean;
|
|
1676
1683
|
appAssets?: [
|
|
1677
1684
|
{
|
|
1678
1685
|
src: string;
|
|
@@ -2771,7 +2778,7 @@ declare class ChannelProvider extends ChannelBase {
|
|
|
2771
2778
|
* a read-only array containing all the identities of connecting clients.
|
|
2772
2779
|
*/
|
|
2773
2780
|
get connections(): OpenFin.ClientConnectionPayload[];
|
|
2774
|
-
static handleClientDisconnection(channel: ChannelProvider, payload:
|
|
2781
|
+
static handleClientDisconnection(channel: ChannelProvider, payload: ClientDisconnectionPayload): void;
|
|
2775
2782
|
static setProviderRemoval(provider: ChannelProvider, remove: Function): void;
|
|
2776
2783
|
/* Excluded from this release type: __constructor */
|
|
2777
2784
|
/**
|
|
@@ -3030,6 +3037,11 @@ declare type ClearCacheOption = {
|
|
|
3030
3037
|
* browser data that can be used across sessions
|
|
3031
3038
|
*/
|
|
3032
3039
|
localStorage?: boolean;
|
|
3040
|
+
/**
|
|
3041
|
+
* Clears saved window-state data written for windows that use `saveWindowState`.
|
|
3042
|
+
* After this data is cleared, previously persisted bounds and state (Maximized/Minimized) will not be restored until new state is written again.
|
|
3043
|
+
*/
|
|
3044
|
+
windowState?: boolean;
|
|
3033
3045
|
};
|
|
3034
3046
|
|
|
3035
3047
|
/**
|
|
@@ -3050,6 +3062,10 @@ declare type ClickedMenuResult<Data extends unknown = unknown> = {
|
|
|
3050
3062
|
*/
|
|
3051
3063
|
declare type ClientConnectionPayload = ClientIdentity & ClientInfo;
|
|
3052
3064
|
|
|
3065
|
+
declare type ClientDisconnectionPayload = OpenFin.Identity & {
|
|
3066
|
+
endpointId?: string;
|
|
3067
|
+
};
|
|
3068
|
+
|
|
3053
3069
|
/**
|
|
3054
3070
|
* Identity of a channel client. Includes endpointId to differentiate between different connections for an entity.
|
|
3055
3071
|
* @interface
|
|
@@ -3255,6 +3271,7 @@ declare type ClipboardApiPermissions = {
|
|
|
3255
3271
|
writeRtf: boolean;
|
|
3256
3272
|
readRtf: boolean;
|
|
3257
3273
|
write: boolean;
|
|
3274
|
+
setClipboard: boolean;
|
|
3258
3275
|
};
|
|
3259
3276
|
|
|
3260
3277
|
/**
|
|
@@ -4770,20 +4787,11 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
|
|
|
4770
4787
|
eventNames: () => (string | symbol)[];
|
|
4771
4788
|
/* Excluded from this release type: emit */
|
|
4772
4789
|
private hasEmitter;
|
|
4773
|
-
/**
|
|
4774
|
-
* Cleans up after removal of a listener, e.g. deleting any lingering deregistration handlers for a
|
|
4775
|
-
* `once` subscription.
|
|
4776
|
-
*
|
|
4777
|
-
* @remarks Implementing this as a `removeListener` handler ensures that direct removal of a listener
|
|
4778
|
-
* on the base emitter will not leak additional core handlers. We could do this in the forwarding method,
|
|
4779
|
-
* which would involve less "magic," but would be more-vulnerable to accidental re-introduction of a leak.
|
|
4780
|
-
*/
|
|
4781
|
-
private cleanUpRemovedListener;
|
|
4782
4790
|
private getOrCreateEmitter;
|
|
4783
4791
|
listeners: (type: string | symbol) => Function[];
|
|
4784
4792
|
listenerCount: (type: string | symbol) => number;
|
|
4785
4793
|
protected registerEventListener: (eventType: EmitterEventType, options: OpenFin.SubscriptionOptions | undefined, applySubscription: (emitter: EventEmitter) => void, undoSubscription: (emitter: EventEmitter) => void) => Promise<void>;
|
|
4786
|
-
|
|
4794
|
+
private deregisterEventListener;
|
|
4787
4795
|
/**
|
|
4788
4796
|
* Adds a listener to the end of the listeners array for the specified event.
|
|
4789
4797
|
*
|
|
@@ -4819,7 +4827,7 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
|
|
|
4819
4827
|
* @remarks Caution: Calling this method changes the array indices in the listener array behind the listener.
|
|
4820
4828
|
*/
|
|
4821
4829
|
removeListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin.SubscriptionOptions): Promise<this>;
|
|
4822
|
-
|
|
4830
|
+
private deregisterAllListeners;
|
|
4823
4831
|
/**
|
|
4824
4832
|
* Removes all listeners, or those of the specified event.
|
|
4825
4833
|
*
|
|
@@ -5250,6 +5258,19 @@ declare type ExtensionsInstallFailedEvent = ExtensionsEvent & {
|
|
|
5250
5258
|
type: 'extensions-install-failed';
|
|
5251
5259
|
};
|
|
5252
5260
|
|
|
5261
|
+
/**
|
|
5262
|
+
* these api calls are not implemented in the javscript api, only in the external adapter
|
|
5263
|
+
* If they don't exist in the external adapter they should be removed.
|
|
5264
|
+
*/
|
|
5265
|
+
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';
|
|
5266
|
+
|
|
5267
|
+
declare type ExternalAdapterOnlyCallsMap = {
|
|
5268
|
+
[k in ExternalAdapterOnlyCalls]: {
|
|
5269
|
+
request: any;
|
|
5270
|
+
response: any;
|
|
5271
|
+
};
|
|
5272
|
+
};
|
|
5273
|
+
|
|
5253
5274
|
/**
|
|
5254
5275
|
* An ExternalApplication object representing native language adapter connections to the runtime. Allows
|
|
5255
5276
|
* the developer to listen to {@link OpenFin.ExternalApplicationEvents external application events}.
|
|
@@ -6727,6 +6748,16 @@ declare type IntentMetadata<TargetType = any> = {
|
|
|
6727
6748
|
*/
|
|
6728
6749
|
declare class InterApplicationBus extends Base {
|
|
6729
6750
|
Channel: Channel;
|
|
6751
|
+
/**
|
|
6752
|
+
* Event types for the InterApplicationBus.
|
|
6753
|
+
*
|
|
6754
|
+
* @remarks The `subscriber-added` and `subscriber-removed` events are disabled by default.
|
|
6755
|
+
* To re-enable them, launch the runtime with the `--emit-legacy-iab-events` flag.
|
|
6756
|
+
* These events will be removed in a future version. Use {@link Channel} for connection
|
|
6757
|
+
* lifecycle management instead.
|
|
6758
|
+
*
|
|
6759
|
+
* @deprecated Use {@link Channel} `onConnection` / `onDisconnection` instead.
|
|
6760
|
+
*/
|
|
6730
6761
|
events: {
|
|
6731
6762
|
subscriberAdded: string;
|
|
6732
6763
|
subscriberRemoved: string;
|
|
@@ -9558,11 +9589,11 @@ declare type MutableWindowOptions = {
|
|
|
9558
9589
|
*/
|
|
9559
9590
|
customData: any;
|
|
9560
9591
|
/**
|
|
9561
|
-
* @deprecated Will be removed in runtime version 45
|
|
9562
|
-
* @defaultValue true
|
|
9563
|
-
*
|
|
9564
9592
|
* Show the window's frame.
|
|
9565
9593
|
*
|
|
9594
|
+
* @remarks
|
|
9595
|
+
* This property will not be updatable starting runtime version 45.
|
|
9596
|
+
*
|
|
9566
9597
|
* @default true
|
|
9567
9598
|
*/
|
|
9568
9599
|
frame: boolean;
|
|
@@ -9885,6 +9916,8 @@ declare namespace OpenFin {
|
|
|
9885
9916
|
TabStack,
|
|
9886
9917
|
_Window as Window,
|
|
9887
9918
|
_WindowModule,
|
|
9919
|
+
Clipboard_2 as Clipboard,
|
|
9920
|
+
InterApplicationBus,
|
|
9888
9921
|
InteropClient,
|
|
9889
9922
|
InteropBroker,
|
|
9890
9923
|
InteropModule,
|
|
@@ -12481,7 +12514,7 @@ declare type PropagatedWindowEvent<TargetTopic extends string> = PropagatedEvent
|
|
|
12481
12514
|
*/
|
|
12482
12515
|
declare type PropagatedWindowEventType = PropagatedEvent_3<string>['type'];
|
|
12483
12516
|
|
|
12484
|
-
declare
|
|
12517
|
+
declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap & {
|
|
12485
12518
|
'is-application-running': ApplicationIdentityCall<{}, boolean>;
|
|
12486
12519
|
'destroy-application': ApplicationIdentityCall<{
|
|
12487
12520
|
force: boolean;
|
|
@@ -12548,8 +12581,15 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12548
12581
|
downloadLocation: string;
|
|
12549
12582
|
};
|
|
12550
12583
|
response: void;
|
|
12584
|
+
secure: true;
|
|
12585
|
+
namespace: 'Application';
|
|
12586
|
+
apiPath: '.setFileDownloadLocation';
|
|
12587
|
+
};
|
|
12588
|
+
'get-file-download-location': ApplicationIdentityCall<{}, string> & {
|
|
12589
|
+
secure: true;
|
|
12590
|
+
namespace: 'Application';
|
|
12591
|
+
apiPath: '.getFileDownloadLocation';
|
|
12551
12592
|
};
|
|
12552
|
-
'get-file-download-location': ApplicationIdentityCall<{}, string>;
|
|
12553
12593
|
'show-tray-icon-popup-menu': {
|
|
12554
12594
|
request: OpenFin.Identity & {
|
|
12555
12595
|
options: OpenFin.ShowTrayIconPopupMenuOptions;
|
|
@@ -12557,19 +12597,17 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12557
12597
|
response: OpenFin.MenuResult;
|
|
12558
12598
|
};
|
|
12559
12599
|
'close-tray-icon-popup-menu': IdentityCall<{}, void>;
|
|
12560
|
-
'wrap-application': VoidCall;
|
|
12561
|
-
'wrap-application-sync': VoidCall;
|
|
12562
12600
|
'create-application': ApiCall<OpenFin.ApplicationCreationOptions, void>;
|
|
12563
|
-
'application-create': VoidCall;
|
|
12564
|
-
'start-application': VoidCall;
|
|
12565
12601
|
'run-applications': ApiCall<{
|
|
12566
12602
|
applications: Array<OpenFin.ManifestInfo>;
|
|
12567
12603
|
opts?: OpenFin.RvmLaunchOptions;
|
|
12568
12604
|
}, void>;
|
|
12569
|
-
'
|
|
12570
|
-
|
|
12571
|
-
|
|
12572
|
-
|
|
12605
|
+
'send-analytics-batch': {
|
|
12606
|
+
request: {
|
|
12607
|
+
counts: Record<string, number>;
|
|
12608
|
+
};
|
|
12609
|
+
response: void;
|
|
12610
|
+
};
|
|
12573
12611
|
'request-external-authorization': {
|
|
12574
12612
|
request: any;
|
|
12575
12613
|
response: void;
|
|
@@ -12589,44 +12627,69 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12589
12627
|
'clipboard-read-image': {
|
|
12590
12628
|
request: OpenFin.ReadImageClipboardRequest;
|
|
12591
12629
|
response: string;
|
|
12630
|
+
apiPath: '.readImage';
|
|
12631
|
+
namespace: 'Clipboard';
|
|
12592
12632
|
};
|
|
12593
12633
|
'clipboard-read-text': {
|
|
12594
12634
|
request: {
|
|
12595
12635
|
type?: OpenFin.ClipboardSelectionType;
|
|
12596
12636
|
};
|
|
12597
12637
|
response: string;
|
|
12638
|
+
apiPath: '.readText';
|
|
12639
|
+
namespace: 'Clipboard';
|
|
12598
12640
|
};
|
|
12599
12641
|
'clipboard-read-html': {
|
|
12600
12642
|
request: {
|
|
12601
12643
|
type?: OpenFin.ClipboardSelectionType;
|
|
12602
12644
|
};
|
|
12603
12645
|
response: string;
|
|
12646
|
+
apiPath: '.readHtml';
|
|
12647
|
+
namespace: 'Clipboard';
|
|
12604
12648
|
};
|
|
12605
12649
|
'clipboard-read-rtf': {
|
|
12606
12650
|
request: {
|
|
12607
12651
|
type?: OpenFin.ClipboardSelectionType;
|
|
12608
12652
|
};
|
|
12609
12653
|
response: string;
|
|
12654
|
+
apiPath: '.readRtf';
|
|
12655
|
+
namespace: 'Clipboard';
|
|
12610
12656
|
};
|
|
12611
12657
|
'clipboard-write-image': {
|
|
12612
12658
|
request: OpenFin.WriteImageClipboardRequest;
|
|
12613
12659
|
response: void;
|
|
12660
|
+
apiPath: '.writeImage';
|
|
12661
|
+
namespace: 'Clipboard';
|
|
12614
12662
|
};
|
|
12615
12663
|
'clipboard-write': {
|
|
12616
12664
|
request: OpenFin.WriteAnyRequestType;
|
|
12617
12665
|
response: void;
|
|
12666
|
+
apiPath: '.write';
|
|
12667
|
+
namespace: 'Clipboard';
|
|
12618
12668
|
};
|
|
12619
12669
|
'clipboard-write-text': {
|
|
12620
12670
|
request: OpenFin.WriteClipboardRequest;
|
|
12621
12671
|
response: void;
|
|
12672
|
+
apiPath: '.writeText';
|
|
12673
|
+
namespace: 'Clipboard';
|
|
12674
|
+
foo: '';
|
|
12675
|
+
};
|
|
12676
|
+
'set-clipboard': {
|
|
12677
|
+
request: OpenFin.WriteClipboardRequest;
|
|
12678
|
+
response: void;
|
|
12679
|
+
apiPath: '.setClipboard';
|
|
12680
|
+
namespace: 'Clipboard';
|
|
12622
12681
|
};
|
|
12623
12682
|
'clipboard-write-html': {
|
|
12624
12683
|
request: OpenFin.WriteClipboardRequest;
|
|
12625
12684
|
response: void;
|
|
12685
|
+
apiPath: '.writeHtml';
|
|
12686
|
+
namespace: 'Clipboard';
|
|
12626
12687
|
};
|
|
12627
12688
|
'clipboard-write-rtf': {
|
|
12628
12689
|
request: OpenFin.WriteClipboardRequest;
|
|
12629
12690
|
response: void;
|
|
12691
|
+
apiPath: '.writeRtf';
|
|
12692
|
+
namespace: 'Clipboard';
|
|
12630
12693
|
};
|
|
12631
12694
|
'get-view-window': IdentityCall<{}, OpenFin.Identity>;
|
|
12632
12695
|
'create-view': IdentityCall<OpenFin.ViewCreationOptions & {
|
|
@@ -12653,18 +12716,10 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12653
12716
|
options: OpenFin.UpdatableViewOptions;
|
|
12654
12717
|
}>;
|
|
12655
12718
|
'trigger-before-unload': IdentityCall<{}, boolean>;
|
|
12656
|
-
'view-wrap-sync': VoidCall;
|
|
12657
|
-
'view-wrap': VoidCall;
|
|
12658
|
-
'view-get-current': VoidCall;
|
|
12659
|
-
'view-get-current-sync': VoidCall;
|
|
12660
12719
|
'animate-window': IdentityCall<{
|
|
12661
12720
|
transitions: OpenFin.Transition;
|
|
12662
12721
|
options: OpenFin.TransitionOptions;
|
|
12663
12722
|
}>;
|
|
12664
|
-
'activate-window-and-focus': ApiCall<{
|
|
12665
|
-
winIdentity: OpenFin.Identity;
|
|
12666
|
-
focusIdentity: OpenFin.Identity;
|
|
12667
|
-
}, boolean>;
|
|
12668
12723
|
'get-all-frames': IdentityCall<{}, OpenFin.FrameInfo[]>;
|
|
12669
12724
|
'get-window-bounds': IdentityCall<{
|
|
12670
12725
|
options?: OpenFin.GetBoundsOptions;
|
|
@@ -12753,15 +12808,13 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12753
12808
|
'create-window': VoidCall;
|
|
12754
12809
|
'get-current-window': VoidCall;
|
|
12755
12810
|
'get-current-window-sync': VoidCall;
|
|
12811
|
+
'activate-window-and-focus': ApiCall<{
|
|
12812
|
+
winIdentity: OpenFin.Identity;
|
|
12813
|
+
focusIdentity: OpenFin.Identity;
|
|
12814
|
+
}, boolean>;
|
|
12756
12815
|
'get-external-application-info': ApiCall<OpenFin.ApplicationIdentity, OpenFin.ExternalApplicationInfo>;
|
|
12757
|
-
'external-application-wrap': VoidCall;
|
|
12758
|
-
'external-application-wrap-sync': VoidCall;
|
|
12759
12816
|
'get-frame-info': ApiCall<OpenFin.Identity, OpenFin.FrameInfo>;
|
|
12760
12817
|
'get-parent-window': ApiCall<OpenFin.Identity, OpenFin.FrameInfo>;
|
|
12761
|
-
'frame-wrap': VoidCall;
|
|
12762
|
-
'frame-wrap-sync': VoidCall;
|
|
12763
|
-
'frame-get-current': VoidCall;
|
|
12764
|
-
'frame-get-current-sync': VoidCall;
|
|
12765
12818
|
'global-hotkey-register': {
|
|
12766
12819
|
request: {
|
|
12767
12820
|
hotkey: string;
|
|
@@ -12845,6 +12898,10 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12845
12898
|
request: any;
|
|
12846
12899
|
response: any;
|
|
12847
12900
|
};
|
|
12901
|
+
'send-channel-result': {
|
|
12902
|
+
request: any;
|
|
12903
|
+
response: any;
|
|
12904
|
+
};
|
|
12848
12905
|
'get-version': GetterCall<string>;
|
|
12849
12906
|
'clear-cache': ApiCall<OpenFin.ClearCacheOption, void>;
|
|
12850
12907
|
'delete-cache-request': VoidCall;
|
|
@@ -12894,7 +12951,11 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12894
12951
|
action: string;
|
|
12895
12952
|
runtimes: string[];
|
|
12896
12953
|
}>;
|
|
12897
|
-
'get-installed-apps': GetterCall<OpenFin.InstalledApps
|
|
12954
|
+
'get-installed-apps': GetterCall<OpenFin.InstalledApps> & {
|
|
12955
|
+
secure: true;
|
|
12956
|
+
apiPath: '.getInstalledApps';
|
|
12957
|
+
namespace: 'System';
|
|
12958
|
+
};
|
|
12898
12959
|
'view-log': ApiCall<OpenFin.GetLogRequestType, string>;
|
|
12899
12960
|
'get-machine-id': GetterCall<string>;
|
|
12900
12961
|
'get-min-log-level': GetterCall<OpenFin.LogLevel>;
|
|
@@ -12907,8 +12968,16 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12907
12968
|
'get-runtime-info': GetterCall<OpenFin.RuntimeInfo>;
|
|
12908
12969
|
'get-rvm-info': GetterCall<OpenFin.RVMInfo>;
|
|
12909
12970
|
'get-host-specs': GetterCall<OpenFin.HostSpecs>;
|
|
12910
|
-
'get-os-info': GetterCall<OpenFin.OSInfo
|
|
12911
|
-
|
|
12971
|
+
'get-os-info': GetterCall<OpenFin.OSInfo> & {
|
|
12972
|
+
secure: true;
|
|
12973
|
+
apiPath: '.getOSInfo';
|
|
12974
|
+
namespace: 'System';
|
|
12975
|
+
};
|
|
12976
|
+
'launch-external-process': ApiCall<OpenFin.ExternalProcessRequestType, OpenFin.Identity> & {
|
|
12977
|
+
secure: true;
|
|
12978
|
+
apiPath: '.launchExternalProcess';
|
|
12979
|
+
namespace: 'System';
|
|
12980
|
+
};
|
|
12912
12981
|
'monitor-external-process': ApiCall<OpenFin.ExternalProcessInfo, OpenFin.Identity>;
|
|
12913
12982
|
'write-to-log': ApiCall<{
|
|
12914
12983
|
level: string;
|
|
@@ -12916,25 +12985,48 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12916
12985
|
}, void>;
|
|
12917
12986
|
'open-url-with-browser': ApiCall<{
|
|
12918
12987
|
url: string;
|
|
12919
|
-
}, void
|
|
12920
|
-
|
|
12988
|
+
}, void> & {
|
|
12989
|
+
secure: true;
|
|
12990
|
+
apiPath: '.openUrlWithBrowser';
|
|
12991
|
+
namespace: 'System';
|
|
12992
|
+
};
|
|
12993
|
+
'register-custom-protocol': ApiCall<OpenFin.CustomProtocolOptions, void> & {
|
|
12994
|
+
secure: true;
|
|
12995
|
+
apiPath: '.registerCustomProtocol';
|
|
12996
|
+
namespace: 'System';
|
|
12997
|
+
};
|
|
12921
12998
|
'unregister-custom-protocol': ApiCall<{
|
|
12922
12999
|
protocolName: string;
|
|
12923
|
-
}, void
|
|
13000
|
+
}, void> & {
|
|
13001
|
+
secure: true;
|
|
13002
|
+
apiPath: '.unregisterCustomProtocol';
|
|
13003
|
+
namespace: 'System';
|
|
13004
|
+
};
|
|
12924
13005
|
'get-custom-protocol-state': ApiCall<{
|
|
12925
13006
|
protocolName: string;
|
|
12926
|
-
}, OpenFin.CustomProtocolState
|
|
13007
|
+
}, OpenFin.CustomProtocolState> & {
|
|
13008
|
+
secure: true;
|
|
13009
|
+
apiPath: '.getCustomProtocolState';
|
|
13010
|
+
namespace: 'System';
|
|
13011
|
+
};
|
|
12927
13012
|
'release-external-process': ApiCall<{
|
|
12928
13013
|
uuid: string;
|
|
12929
13014
|
}, void>;
|
|
12930
13015
|
'show-developer-tools': ApiCall<OpenFin.Identity, void>;
|
|
12931
|
-
'terminate-external-process': ApiCall<OpenFin.TerminateExternalRequestType, void
|
|
13016
|
+
'terminate-external-process': ApiCall<OpenFin.TerminateExternalRequestType, void> & {
|
|
13017
|
+
secure: true;
|
|
13018
|
+
apiPath: '.terminateExternalProcess';
|
|
13019
|
+
namespace: 'System';
|
|
13020
|
+
};
|
|
12932
13021
|
'update-proxy': ApiCall<OpenFin.ProxyConfig, void>;
|
|
12933
13022
|
'download-asset': {
|
|
12934
13023
|
request: OpenFin.AppAssetInfo & {
|
|
12935
13024
|
downloadId: string;
|
|
12936
13025
|
};
|
|
12937
13026
|
response: void;
|
|
13027
|
+
secure: true;
|
|
13028
|
+
apiPath: '.downloadAsset';
|
|
13029
|
+
namespace: 'System';
|
|
12938
13030
|
};
|
|
12939
13031
|
'download-runtime': {
|
|
12940
13032
|
request: OpenFin.RuntimeDownloadOptions & {
|
|
@@ -12963,7 +13055,11 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12963
13055
|
rootKey: string;
|
|
12964
13056
|
subkey: string;
|
|
12965
13057
|
value: string;
|
|
12966
|
-
}, OpenFin.RegistryInfo
|
|
13058
|
+
}, OpenFin.RegistryInfo> & {
|
|
13059
|
+
secure: true;
|
|
13060
|
+
apiPath: '.readRegistryValue';
|
|
13061
|
+
namespace: 'System';
|
|
13062
|
+
};
|
|
12967
13063
|
'register-external-connection': ApiCall<{
|
|
12968
13064
|
uuid: string;
|
|
12969
13065
|
}, OpenFin.ExternalConnection>;
|
|
@@ -12997,26 +13093,48 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12997
13093
|
permissions: any;
|
|
12998
13094
|
};
|
|
12999
13095
|
response: OpenFin.NativeWindowIntegrationProviderAuthorization;
|
|
13096
|
+
secure: true;
|
|
13097
|
+
apiPath: '.enableNativeWindowIntegrationProvider';
|
|
13098
|
+
namespace: 'System';
|
|
13000
13099
|
};
|
|
13001
13100
|
'register-usage': ApiCall<OpenFin.RegisterUsageData, void>;
|
|
13002
13101
|
'system-get-printers': GetterCall<OpenFin.PrinterInfo[]>;
|
|
13003
13102
|
'system-update-process-logging-options': ApiCall<{
|
|
13004
13103
|
options: OpenFin.ProcessLoggingOptions;
|
|
13005
13104
|
}, void>;
|
|
13006
|
-
'get-domain-settings': ApiCall<void, OpenFin.DomainSettings
|
|
13105
|
+
'get-domain-settings': ApiCall<void, OpenFin.DomainSettings> & {
|
|
13106
|
+
secure: true;
|
|
13107
|
+
apiPath: '.getDomainSettings';
|
|
13108
|
+
namespace: 'System';
|
|
13109
|
+
};
|
|
13007
13110
|
'serve-asset': ApiCall<{
|
|
13008
13111
|
options: OpenFin.ServeAssetOptions;
|
|
13009
|
-
}, OpenFin.ServedAssetInfo
|
|
13112
|
+
}, OpenFin.ServedAssetInfo> & {
|
|
13113
|
+
secure: true;
|
|
13114
|
+
apiPath: '.serveAsset';
|
|
13115
|
+
namespace: 'System';
|
|
13116
|
+
};
|
|
13010
13117
|
'set-domain-settings': ApiCall<{
|
|
13011
13118
|
domainSettings: OpenFin.DomainSettings;
|
|
13012
|
-
}, void
|
|
13119
|
+
}, void> & {
|
|
13120
|
+
secure: true;
|
|
13121
|
+
apiPath: '.setDomainSettings';
|
|
13122
|
+
namespace: 'System';
|
|
13123
|
+
};
|
|
13013
13124
|
'get-current-domain-settings': ApiCall<{
|
|
13014
13125
|
identity: OpenFin.Identity;
|
|
13015
|
-
}, OpenFin.ResolvedDomainSettings
|
|
13126
|
+
}, OpenFin.ResolvedDomainSettings> & {
|
|
13127
|
+
secure: true;
|
|
13128
|
+
apiPath: '.getCurrentDomainSettings';
|
|
13129
|
+
namespace: 'System';
|
|
13130
|
+
};
|
|
13016
13131
|
'resolve-domain-settings': ApiCall<{
|
|
13017
13132
|
url: string;
|
|
13018
|
-
}, OpenFin.ResolvedDomainSettings
|
|
13019
|
-
|
|
13133
|
+
}, OpenFin.ResolvedDomainSettings> & {
|
|
13134
|
+
secure: true;
|
|
13135
|
+
apiPath: '.resolveDomainSettings';
|
|
13136
|
+
namespace: 'System';
|
|
13137
|
+
};
|
|
13020
13138
|
'get-permissions': GetterCall<any>;
|
|
13021
13139
|
'refresh-extensions': {
|
|
13022
13140
|
request: void;
|
|
@@ -13026,24 +13144,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13026
13144
|
request: void;
|
|
13027
13145
|
response: OpenFin.ExtensionInfo[];
|
|
13028
13146
|
};
|
|
13029
|
-
'fdc3-add-context-listener': VoidCall;
|
|
13030
|
-
'fdc3-add-intent-listener': VoidCall;
|
|
13031
|
-
'fdc3-raise-intent': VoidCall;
|
|
13032
|
-
'fdc3-find-intent': VoidCall;
|
|
13033
|
-
'fdc3-find-intents-by-context': VoidCall;
|
|
13034
|
-
'fdc3-raise-intent-for-context': VoidCall;
|
|
13035
|
-
'fdc3-get-info': VoidCall;
|
|
13036
|
-
'fdc3-find-instances': VoidCall;
|
|
13037
|
-
'fdc3-get-app-metadata': VoidCall;
|
|
13038
|
-
'fdc3-broadcast': VoidCall;
|
|
13039
|
-
'fdc3-open': VoidCall;
|
|
13040
|
-
'fdc3-get-or-create-channel': VoidCall;
|
|
13041
|
-
'fdc3-get-system-channels': VoidCall;
|
|
13042
|
-
'fdc3-join-channel': VoidCall;
|
|
13043
|
-
'fdc3-get-current-channel': VoidCall;
|
|
13044
|
-
'fdc3-leave-current-channel': VoidCall;
|
|
13045
|
-
'interop-init': VoidCall;
|
|
13046
|
-
'interop-connect-sync': VoidCall;
|
|
13047
13147
|
'interop-client-set-context': VoidCall;
|
|
13048
13148
|
'interop-client-add-context-handler': VoidCall;
|
|
13049
13149
|
'interop-client-get-context-groups': VoidCall;
|
|
@@ -13074,12 +13174,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13074
13174
|
'interop-session-context-group-set-context': VoidCall;
|
|
13075
13175
|
'interop-session-context-group-get-context': VoidCall;
|
|
13076
13176
|
'interop-session-context-group-add-handler': VoidCall;
|
|
13077
|
-
'platform-wrap': VoidCall;
|
|
13078
|
-
'platform-wrap-sync': VoidCall;
|
|
13079
|
-
'platform-get-current': VoidCall;
|
|
13080
|
-
'platform-get-current-sync': VoidCall;
|
|
13081
|
-
'platform-start': VoidCall;
|
|
13082
|
-
'platform-start-from-manifest': VoidCall;
|
|
13083
13177
|
'platform-get-client': ApplicationIdentityCall<{}, void>;
|
|
13084
13178
|
'platform-create-view': ApplicationIdentityCall<{}, void>;
|
|
13085
13179
|
'platform-create-window': ApplicationIdentityCall<{}, void>;
|
|
@@ -13092,11 +13186,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13092
13186
|
'platform-set-window-context': ApplicationIdentityCall<{}, void>;
|
|
13093
13187
|
'platform-get-window-context': ApplicationIdentityCall<{}, void>;
|
|
13094
13188
|
'platform-close-window': ApplicationIdentityCall<{}, void>;
|
|
13095
|
-
'layout-wrap': VoidCall;
|
|
13096
|
-
'layout-wrap-sync': VoidCall;
|
|
13097
|
-
'layout-get-current': VoidCall;
|
|
13098
|
-
'layout-get-current-sync': VoidCall;
|
|
13099
|
-
'layout-init': VoidCall;
|
|
13100
13189
|
'layout-get-config': VoidCall;
|
|
13101
13190
|
'layout-get-views': VoidCall;
|
|
13102
13191
|
'layout-replace': VoidCall;
|
|
@@ -13115,12 +13204,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13115
13204
|
'layout-controller-create-adjacent-stack': VoidCall;
|
|
13116
13205
|
'layout-controller-get-adjacent-stacks': VoidCall;
|
|
13117
13206
|
'layout-controller-set-stack-active-view': VoidCall;
|
|
13118
|
-
'snapshot-source-init': VoidCall;
|
|
13119
|
-
'snapshot-source-wrap-sync': VoidCall;
|
|
13120
|
-
'snapshot-source-wrap': VoidCall;
|
|
13121
|
-
'snapshot-source-ready': VoidCall;
|
|
13122
|
-
'snapshot-source-get-snapshot': VoidCall;
|
|
13123
|
-
'snapshot-source-apply-snapshot': VoidCall;
|
|
13124
13207
|
'capture-page': IdentityCall<{
|
|
13125
13208
|
options?: OpenFin.CapturePageOptions;
|
|
13126
13209
|
}, string>;
|
|
@@ -13201,15 +13284,27 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13201
13284
|
};
|
|
13202
13285
|
response: void;
|
|
13203
13286
|
};
|
|
13204
|
-
|
|
13205
|
-
|
|
13206
|
-
|
|
13207
|
-
|
|
13208
|
-
|
|
13209
|
-
|
|
13210
|
-
|
|
13287
|
+
'subscribe-to-desktop-event': {
|
|
13288
|
+
request: {
|
|
13289
|
+
topic: string;
|
|
13290
|
+
type: string;
|
|
13291
|
+
uuid?: string;
|
|
13292
|
+
name?: string;
|
|
13293
|
+
timestamp?: number;
|
|
13294
|
+
};
|
|
13295
|
+
response: void;
|
|
13211
13296
|
};
|
|
13212
|
-
|
|
13297
|
+
'unsubscribe-to-desktop-event': {
|
|
13298
|
+
request: {
|
|
13299
|
+
topic: string;
|
|
13300
|
+
type: string;
|
|
13301
|
+
uuid?: string;
|
|
13302
|
+
name?: string;
|
|
13303
|
+
timestamp?: number;
|
|
13304
|
+
};
|
|
13305
|
+
response: void;
|
|
13306
|
+
};
|
|
13307
|
+
};
|
|
13213
13308
|
|
|
13214
13309
|
declare type ProtocolOffer = ClassicProtocolOffer | RTCProtocolOffer;
|
|
13215
13310
|
|
|
@@ -13775,7 +13870,9 @@ declare type SecurityRealmEvent = BaseEvent_9 & {
|
|
|
13775
13870
|
|
|
13776
13871
|
declare type SendActionResponse<T extends keyof ProtocolMap> = Message<{
|
|
13777
13872
|
data: ProtocolMap[T]['response'];
|
|
13778
|
-
} & ProtocolMap[T]
|
|
13873
|
+
} & (ProtocolMap[T] extends {
|
|
13874
|
+
specialResponse: infer U;
|
|
13875
|
+
} ? U : {})>;
|
|
13779
13876
|
|
|
13780
13877
|
/**
|
|
13781
13878
|
* @interface
|
|
@@ -14284,13 +14381,15 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14284
14381
|
* * cookies: browser [cookies](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies)
|
|
14285
14382
|
* * localStorage: browser data that can be used across sessions ([local storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage))
|
|
14286
14383
|
* * appcache: html5 [application cache](https://developer.mozilla.org/en-US/docs/Web/HTML/Using_the_application_cache)
|
|
14384
|
+
* * windowState: clears data written for windows using `saveWindowState`; after clearing, previously saved bounds and state will not be restored until new state is written
|
|
14287
14385
|
* @example
|
|
14288
14386
|
* ```js
|
|
14289
14387
|
* const clearCacheOptions = {
|
|
14290
14388
|
* appcache: true,
|
|
14291
14389
|
* cache: true,
|
|
14292
14390
|
* cookies: true,
|
|
14293
|
-
* localStorage: true
|
|
14391
|
+
* localStorage: true,
|
|
14392
|
+
* windowState: true
|
|
14294
14393
|
* };
|
|
14295
14394
|
* fin.System.clearCache(clearCacheOptions).then(() => console.log('Cache cleared')).catch(err => console.log(err));
|
|
14296
14395
|
* ```
|
|
@@ -15788,7 +15887,6 @@ declare type SystemEventType = EventType_8;
|
|
|
15788
15887
|
*/
|
|
15789
15888
|
declare type SystemPermissions = {
|
|
15790
15889
|
getOSInfo: boolean;
|
|
15791
|
-
getAllExternalWindows: boolean;
|
|
15792
15890
|
setDomainSettings: boolean;
|
|
15793
15891
|
getDomainSettings: boolean;
|
|
15794
15892
|
getCurrentDomainSettings: boolean;
|
|
@@ -15828,6 +15926,10 @@ declare type SystemPermissions = {
|
|
|
15828
15926
|
enabled: boolean;
|
|
15829
15927
|
protocols: string[];
|
|
15830
15928
|
};
|
|
15929
|
+
getInstalledApps: boolean;
|
|
15930
|
+
downloadAsset: boolean;
|
|
15931
|
+
serveAsset: boolean;
|
|
15932
|
+
enableNativeWindowIntegrationProvider: boolean;
|
|
15831
15933
|
};
|
|
15832
15934
|
|
|
15833
15935
|
/**
|
|
@@ -16129,9 +16231,12 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
|
|
|
16129
16231
|
sendRaw: Wire['send'];
|
|
16130
16232
|
eventAggregator: EventAggregator;
|
|
16131
16233
|
protected messageHandlers: MessageHandler[];
|
|
16132
|
-
constructor(factory: WireFactory, environment: Environment, config: OpenFin.Identity
|
|
16234
|
+
constructor(factory: WireFactory, environment: Environment, config: OpenFin.Identity & {
|
|
16235
|
+
apiDiagnostics?: boolean;
|
|
16236
|
+
});
|
|
16133
16237
|
getFin(): OpenFin.Fin<MeType>;
|
|
16134
16238
|
registerFin(_fin: OpenFin.Fin<MeType>): void;
|
|
16239
|
+
recordAnalytic(action: string): void;
|
|
16135
16240
|
connectSync: () => void;
|
|
16136
16241
|
getPort: () => string;
|
|
16137
16242
|
shutdown(): Promise<void>;
|
|
@@ -16139,7 +16244,7 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
|
|
|
16139
16244
|
private connectRemote;
|
|
16140
16245
|
connectByPort(config: ExistingConnectConfig): Promise<void>;
|
|
16141
16246
|
private authorize;
|
|
16142
|
-
sendAction<T extends keyof ProtocolMap
|
|
16247
|
+
sendAction<T extends keyof ProtocolMap>(action: T, payload?: ProtocolMap[T]['request'], uncorrelated?: boolean): SentMessage<SendActionResponse<T>>;
|
|
16143
16248
|
protected nackHandler(payloadOrMessage: RuntimeErrorPayload | string, reject: Function, callSites?: NodeJS.CallSite[]): void;
|
|
16144
16249
|
ferryAction(origData: any): Promise<Message<any>>;
|
|
16145
16250
|
registerMessageHandler(handler: MessageHandler): void;
|