@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.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>;
|
|
@@ -1705,6 +1711,7 @@ declare type BaseConfig = {
|
|
|
1705
1711
|
devToolsPort?: number;
|
|
1706
1712
|
installerUI?: boolean;
|
|
1707
1713
|
runtime?: RuntimeConfig;
|
|
1714
|
+
apiDiagnostics?: boolean;
|
|
1708
1715
|
appAssets?: [
|
|
1709
1716
|
{
|
|
1710
1717
|
src: string;
|
|
@@ -2824,7 +2831,7 @@ declare class ChannelProvider extends ChannelBase {
|
|
|
2824
2831
|
* a read-only array containing all the identities of connecting clients.
|
|
2825
2832
|
*/
|
|
2826
2833
|
get connections(): OpenFin.ClientConnectionPayload[];
|
|
2827
|
-
static handleClientDisconnection(channel: ChannelProvider, payload:
|
|
2834
|
+
static handleClientDisconnection(channel: ChannelProvider, payload: ClientDisconnectionPayload): void;
|
|
2828
2835
|
static setProviderRemoval(provider: ChannelProvider, remove: Function): void;
|
|
2829
2836
|
/**
|
|
2830
2837
|
* @internal
|
|
@@ -3086,6 +3093,11 @@ declare type ClearCacheOption = {
|
|
|
3086
3093
|
* browser data that can be used across sessions
|
|
3087
3094
|
*/
|
|
3088
3095
|
localStorage?: boolean;
|
|
3096
|
+
/**
|
|
3097
|
+
* Clears saved window-state data written for windows that use `saveWindowState`.
|
|
3098
|
+
* After this data is cleared, previously persisted bounds and state (Maximized/Minimized) will not be restored until new state is written again.
|
|
3099
|
+
*/
|
|
3100
|
+
windowState?: boolean;
|
|
3089
3101
|
};
|
|
3090
3102
|
|
|
3091
3103
|
/**
|
|
@@ -3106,6 +3118,10 @@ declare type ClickedMenuResult<Data extends unknown = unknown> = {
|
|
|
3106
3118
|
*/
|
|
3107
3119
|
declare type ClientConnectionPayload = ClientIdentity & ClientInfo;
|
|
3108
3120
|
|
|
3121
|
+
declare type ClientDisconnectionPayload = OpenFin.Identity & {
|
|
3122
|
+
endpointId?: string;
|
|
3123
|
+
};
|
|
3124
|
+
|
|
3109
3125
|
/**
|
|
3110
3126
|
* Identity of a channel client. Includes endpointId to differentiate between different connections for an entity.
|
|
3111
3127
|
* @interface
|
|
@@ -3311,6 +3327,7 @@ declare type ClipboardApiPermissions = {
|
|
|
3311
3327
|
writeRtf: boolean;
|
|
3312
3328
|
readRtf: boolean;
|
|
3313
3329
|
write: boolean;
|
|
3330
|
+
setClipboard: boolean;
|
|
3314
3331
|
};
|
|
3315
3332
|
|
|
3316
3333
|
/**
|
|
@@ -4834,20 +4851,11 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
|
|
|
4834
4851
|
type: EventType;
|
|
4835
4852
|
}>, ...args: any[]) => boolean;
|
|
4836
4853
|
private hasEmitter;
|
|
4837
|
-
/**
|
|
4838
|
-
* Cleans up after removal of a listener, e.g. deleting any lingering deregistration handlers for a
|
|
4839
|
-
* `once` subscription.
|
|
4840
|
-
*
|
|
4841
|
-
* @remarks Implementing this as a `removeListener` handler ensures that direct removal of a listener
|
|
4842
|
-
* on the base emitter will not leak additional core handlers. We could do this in the forwarding method,
|
|
4843
|
-
* which would involve less "magic," but would be more-vulnerable to accidental re-introduction of a leak.
|
|
4844
|
-
*/
|
|
4845
|
-
private cleanUpRemovedListener;
|
|
4846
4854
|
private getOrCreateEmitter;
|
|
4847
4855
|
listeners: (type: string | symbol) => Function[];
|
|
4848
4856
|
listenerCount: (type: string | symbol) => number;
|
|
4849
4857
|
protected registerEventListener: (eventType: EmitterEventType, options: OpenFin.SubscriptionOptions | undefined, applySubscription: (emitter: EventEmitter) => void, undoSubscription: (emitter: EventEmitter) => void) => Promise<void>;
|
|
4850
|
-
|
|
4858
|
+
private deregisterEventListener;
|
|
4851
4859
|
/**
|
|
4852
4860
|
* Adds a listener to the end of the listeners array for the specified event.
|
|
4853
4861
|
*
|
|
@@ -4883,7 +4891,7 @@ declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType exten
|
|
|
4883
4891
|
* @remarks Caution: Calling this method changes the array indices in the listener array behind the listener.
|
|
4884
4892
|
*/
|
|
4885
4893
|
removeListener<EventType extends EmitterEventType>(eventType: EventType, listener: EventHandler<EmitterEvent, EventType>, options?: OpenFin.SubscriptionOptions): Promise<this>;
|
|
4886
|
-
|
|
4894
|
+
private deregisterAllListeners;
|
|
4887
4895
|
/**
|
|
4888
4896
|
* Removes all listeners, or those of the specified event.
|
|
4889
4897
|
*
|
|
@@ -5332,6 +5340,19 @@ declare type ExtensionsInstallFailedEvent = ExtensionsEvent & {
|
|
|
5332
5340
|
type: 'extensions-install-failed';
|
|
5333
5341
|
};
|
|
5334
5342
|
|
|
5343
|
+
/**
|
|
5344
|
+
* these api calls are not implemented in the javscript api, only in the external adapter
|
|
5345
|
+
* If they don't exist in the external adapter they should be removed.
|
|
5346
|
+
*/
|
|
5347
|
+
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';
|
|
5348
|
+
|
|
5349
|
+
declare type ExternalAdapterOnlyCallsMap = {
|
|
5350
|
+
[k in ExternalAdapterOnlyCalls]: {
|
|
5351
|
+
request: any;
|
|
5352
|
+
response: any;
|
|
5353
|
+
};
|
|
5354
|
+
};
|
|
5355
|
+
|
|
5335
5356
|
/**
|
|
5336
5357
|
* An ExternalApplication object representing native language adapter connections to the runtime. Allows
|
|
5337
5358
|
* the developer to listen to {@link OpenFin.ExternalApplicationEvents external application events}.
|
|
@@ -6821,6 +6842,16 @@ declare type IntentMetadata<TargetType = any> = {
|
|
|
6821
6842
|
*/
|
|
6822
6843
|
declare class InterApplicationBus extends Base {
|
|
6823
6844
|
Channel: Channel;
|
|
6845
|
+
/**
|
|
6846
|
+
* Event types for the InterApplicationBus.
|
|
6847
|
+
*
|
|
6848
|
+
* @remarks The `subscriber-added` and `subscriber-removed` events are disabled by default.
|
|
6849
|
+
* To re-enable them, launch the runtime with the `--emit-legacy-iab-events` flag.
|
|
6850
|
+
* These events will be removed in a future version. Use {@link Channel} for connection
|
|
6851
|
+
* lifecycle management instead.
|
|
6852
|
+
*
|
|
6853
|
+
* @deprecated Use {@link Channel} `onConnection` / `onDisconnection` instead.
|
|
6854
|
+
*/
|
|
6824
6855
|
events: {
|
|
6825
6856
|
subscriberAdded: string;
|
|
6826
6857
|
subscriberRemoved: string;
|
|
@@ -9858,11 +9889,11 @@ declare type MutableWindowOptions = {
|
|
|
9858
9889
|
*/
|
|
9859
9890
|
customData: any;
|
|
9860
9891
|
/**
|
|
9861
|
-
* @deprecated Will be removed in runtime version 45
|
|
9862
|
-
* @defaultValue true
|
|
9863
|
-
*
|
|
9864
9892
|
* Show the window's frame.
|
|
9865
9893
|
*
|
|
9894
|
+
* @remarks
|
|
9895
|
+
* This property will not be updatable starting runtime version 45.
|
|
9896
|
+
*
|
|
9866
9897
|
* @default true
|
|
9867
9898
|
*/
|
|
9868
9899
|
frame: boolean;
|
|
@@ -10203,6 +10234,8 @@ declare namespace OpenFin {
|
|
|
10203
10234
|
TabStack,
|
|
10204
10235
|
_Window as Window,
|
|
10205
10236
|
_WindowModule,
|
|
10237
|
+
Clipboard_2 as Clipboard,
|
|
10238
|
+
InterApplicationBus,
|
|
10206
10239
|
InteropClient,
|
|
10207
10240
|
InteropBroker,
|
|
10208
10241
|
InteropModule,
|
|
@@ -12882,7 +12915,7 @@ declare type PropagatedWindowEvent<TargetTopic extends string> = PropagatedEvent
|
|
|
12882
12915
|
*/
|
|
12883
12916
|
declare type PropagatedWindowEventType = PropagatedEvent_3<string>['type'];
|
|
12884
12917
|
|
|
12885
|
-
declare
|
|
12918
|
+
declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap & {
|
|
12886
12919
|
'is-application-running': ApplicationIdentityCall<{}, boolean>;
|
|
12887
12920
|
'destroy-application': ApplicationIdentityCall<{
|
|
12888
12921
|
force: boolean;
|
|
@@ -12949,8 +12982,15 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12949
12982
|
downloadLocation: string;
|
|
12950
12983
|
};
|
|
12951
12984
|
response: void;
|
|
12985
|
+
secure: true;
|
|
12986
|
+
namespace: 'Application';
|
|
12987
|
+
apiPath: '.setFileDownloadLocation';
|
|
12988
|
+
};
|
|
12989
|
+
'get-file-download-location': ApplicationIdentityCall<{}, string> & {
|
|
12990
|
+
secure: true;
|
|
12991
|
+
namespace: 'Application';
|
|
12992
|
+
apiPath: '.getFileDownloadLocation';
|
|
12952
12993
|
};
|
|
12953
|
-
'get-file-download-location': ApplicationIdentityCall<{}, string>;
|
|
12954
12994
|
'show-tray-icon-popup-menu': {
|
|
12955
12995
|
request: OpenFin.Identity & {
|
|
12956
12996
|
options: OpenFin.ShowTrayIconPopupMenuOptions;
|
|
@@ -12958,19 +12998,17 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12958
12998
|
response: OpenFin.MenuResult;
|
|
12959
12999
|
};
|
|
12960
13000
|
'close-tray-icon-popup-menu': IdentityCall<{}, void>;
|
|
12961
|
-
'wrap-application': VoidCall;
|
|
12962
|
-
'wrap-application-sync': VoidCall;
|
|
12963
13001
|
'create-application': ApiCall<OpenFin.ApplicationCreationOptions, void>;
|
|
12964
|
-
'application-create': VoidCall;
|
|
12965
|
-
'start-application': VoidCall;
|
|
12966
13002
|
'run-applications': ApiCall<{
|
|
12967
13003
|
applications: Array<OpenFin.ManifestInfo>;
|
|
12968
13004
|
opts?: OpenFin.RvmLaunchOptions;
|
|
12969
13005
|
}, void>;
|
|
12970
|
-
'
|
|
12971
|
-
|
|
12972
|
-
|
|
12973
|
-
|
|
13006
|
+
'send-analytics-batch': {
|
|
13007
|
+
request: {
|
|
13008
|
+
counts: Record<string, number>;
|
|
13009
|
+
};
|
|
13010
|
+
response: void;
|
|
13011
|
+
};
|
|
12974
13012
|
'request-external-authorization': {
|
|
12975
13013
|
request: any;
|
|
12976
13014
|
response: void;
|
|
@@ -12990,44 +13028,69 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12990
13028
|
'clipboard-read-image': {
|
|
12991
13029
|
request: OpenFin.ReadImageClipboardRequest;
|
|
12992
13030
|
response: string;
|
|
13031
|
+
apiPath: '.readImage';
|
|
13032
|
+
namespace: 'Clipboard';
|
|
12993
13033
|
};
|
|
12994
13034
|
'clipboard-read-text': {
|
|
12995
13035
|
request: {
|
|
12996
13036
|
type?: OpenFin.ClipboardSelectionType;
|
|
12997
13037
|
};
|
|
12998
13038
|
response: string;
|
|
13039
|
+
apiPath: '.readText';
|
|
13040
|
+
namespace: 'Clipboard';
|
|
12999
13041
|
};
|
|
13000
13042
|
'clipboard-read-html': {
|
|
13001
13043
|
request: {
|
|
13002
13044
|
type?: OpenFin.ClipboardSelectionType;
|
|
13003
13045
|
};
|
|
13004
13046
|
response: string;
|
|
13047
|
+
apiPath: '.readHtml';
|
|
13048
|
+
namespace: 'Clipboard';
|
|
13005
13049
|
};
|
|
13006
13050
|
'clipboard-read-rtf': {
|
|
13007
13051
|
request: {
|
|
13008
13052
|
type?: OpenFin.ClipboardSelectionType;
|
|
13009
13053
|
};
|
|
13010
13054
|
response: string;
|
|
13055
|
+
apiPath: '.readRtf';
|
|
13056
|
+
namespace: 'Clipboard';
|
|
13011
13057
|
};
|
|
13012
13058
|
'clipboard-write-image': {
|
|
13013
13059
|
request: OpenFin.WriteImageClipboardRequest;
|
|
13014
13060
|
response: void;
|
|
13061
|
+
apiPath: '.writeImage';
|
|
13062
|
+
namespace: 'Clipboard';
|
|
13015
13063
|
};
|
|
13016
13064
|
'clipboard-write': {
|
|
13017
13065
|
request: OpenFin.WriteAnyRequestType;
|
|
13018
13066
|
response: void;
|
|
13067
|
+
apiPath: '.write';
|
|
13068
|
+
namespace: 'Clipboard';
|
|
13019
13069
|
};
|
|
13020
13070
|
'clipboard-write-text': {
|
|
13021
13071
|
request: OpenFin.WriteClipboardRequest;
|
|
13022
13072
|
response: void;
|
|
13073
|
+
apiPath: '.writeText';
|
|
13074
|
+
namespace: 'Clipboard';
|
|
13075
|
+
foo: '';
|
|
13076
|
+
};
|
|
13077
|
+
'set-clipboard': {
|
|
13078
|
+
request: OpenFin.WriteClipboardRequest;
|
|
13079
|
+
response: void;
|
|
13080
|
+
apiPath: '.setClipboard';
|
|
13081
|
+
namespace: 'Clipboard';
|
|
13023
13082
|
};
|
|
13024
13083
|
'clipboard-write-html': {
|
|
13025
13084
|
request: OpenFin.WriteClipboardRequest;
|
|
13026
13085
|
response: void;
|
|
13086
|
+
apiPath: '.writeHtml';
|
|
13087
|
+
namespace: 'Clipboard';
|
|
13027
13088
|
};
|
|
13028
13089
|
'clipboard-write-rtf': {
|
|
13029
13090
|
request: OpenFin.WriteClipboardRequest;
|
|
13030
13091
|
response: void;
|
|
13092
|
+
apiPath: '.writeRtf';
|
|
13093
|
+
namespace: 'Clipboard';
|
|
13031
13094
|
};
|
|
13032
13095
|
'get-view-window': IdentityCall<{}, OpenFin.Identity>;
|
|
13033
13096
|
'create-view': IdentityCall<OpenFin.ViewCreationOptions & {
|
|
@@ -13054,18 +13117,10 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13054
13117
|
options: OpenFin.UpdatableViewOptions;
|
|
13055
13118
|
}>;
|
|
13056
13119
|
'trigger-before-unload': IdentityCall<{}, boolean>;
|
|
13057
|
-
'view-wrap-sync': VoidCall;
|
|
13058
|
-
'view-wrap': VoidCall;
|
|
13059
|
-
'view-get-current': VoidCall;
|
|
13060
|
-
'view-get-current-sync': VoidCall;
|
|
13061
13120
|
'animate-window': IdentityCall<{
|
|
13062
13121
|
transitions: OpenFin.Transition;
|
|
13063
13122
|
options: OpenFin.TransitionOptions;
|
|
13064
13123
|
}>;
|
|
13065
|
-
'activate-window-and-focus': ApiCall<{
|
|
13066
|
-
winIdentity: OpenFin.Identity;
|
|
13067
|
-
focusIdentity: OpenFin.Identity;
|
|
13068
|
-
}, boolean>;
|
|
13069
13124
|
'get-all-frames': IdentityCall<{}, OpenFin.FrameInfo[]>;
|
|
13070
13125
|
'get-window-bounds': IdentityCall<{
|
|
13071
13126
|
options?: OpenFin.GetBoundsOptions;
|
|
@@ -13154,15 +13209,13 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13154
13209
|
'create-window': VoidCall;
|
|
13155
13210
|
'get-current-window': VoidCall;
|
|
13156
13211
|
'get-current-window-sync': VoidCall;
|
|
13212
|
+
'activate-window-and-focus': ApiCall<{
|
|
13213
|
+
winIdentity: OpenFin.Identity;
|
|
13214
|
+
focusIdentity: OpenFin.Identity;
|
|
13215
|
+
}, boolean>;
|
|
13157
13216
|
'get-external-application-info': ApiCall<OpenFin.ApplicationIdentity, OpenFin.ExternalApplicationInfo>;
|
|
13158
|
-
'external-application-wrap': VoidCall;
|
|
13159
|
-
'external-application-wrap-sync': VoidCall;
|
|
13160
13217
|
'get-frame-info': ApiCall<OpenFin.Identity, OpenFin.FrameInfo>;
|
|
13161
13218
|
'get-parent-window': ApiCall<OpenFin.Identity, OpenFin.FrameInfo>;
|
|
13162
|
-
'frame-wrap': VoidCall;
|
|
13163
|
-
'frame-wrap-sync': VoidCall;
|
|
13164
|
-
'frame-get-current': VoidCall;
|
|
13165
|
-
'frame-get-current-sync': VoidCall;
|
|
13166
13219
|
'global-hotkey-register': {
|
|
13167
13220
|
request: {
|
|
13168
13221
|
hotkey: string;
|
|
@@ -13246,6 +13299,10 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13246
13299
|
request: any;
|
|
13247
13300
|
response: any;
|
|
13248
13301
|
};
|
|
13302
|
+
'send-channel-result': {
|
|
13303
|
+
request: any;
|
|
13304
|
+
response: any;
|
|
13305
|
+
};
|
|
13249
13306
|
'get-version': GetterCall<string>;
|
|
13250
13307
|
'clear-cache': ApiCall<OpenFin.ClearCacheOption, void>;
|
|
13251
13308
|
'delete-cache-request': VoidCall;
|
|
@@ -13295,7 +13352,11 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13295
13352
|
action: string;
|
|
13296
13353
|
runtimes: string[];
|
|
13297
13354
|
}>;
|
|
13298
|
-
'get-installed-apps': GetterCall<OpenFin.InstalledApps
|
|
13355
|
+
'get-installed-apps': GetterCall<OpenFin.InstalledApps> & {
|
|
13356
|
+
secure: true;
|
|
13357
|
+
apiPath: '.getInstalledApps';
|
|
13358
|
+
namespace: 'System';
|
|
13359
|
+
};
|
|
13299
13360
|
'view-log': ApiCall<OpenFin.GetLogRequestType, string>;
|
|
13300
13361
|
'get-machine-id': GetterCall<string>;
|
|
13301
13362
|
'get-min-log-level': GetterCall<OpenFin.LogLevel>;
|
|
@@ -13308,8 +13369,16 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13308
13369
|
'get-runtime-info': GetterCall<OpenFin.RuntimeInfo>;
|
|
13309
13370
|
'get-rvm-info': GetterCall<OpenFin.RVMInfo>;
|
|
13310
13371
|
'get-host-specs': GetterCall<OpenFin.HostSpecs>;
|
|
13311
|
-
'get-os-info': GetterCall<OpenFin.OSInfo
|
|
13312
|
-
|
|
13372
|
+
'get-os-info': GetterCall<OpenFin.OSInfo> & {
|
|
13373
|
+
secure: true;
|
|
13374
|
+
apiPath: '.getOSInfo';
|
|
13375
|
+
namespace: 'System';
|
|
13376
|
+
};
|
|
13377
|
+
'launch-external-process': ApiCall<OpenFin.ExternalProcessRequestType, OpenFin.Identity> & {
|
|
13378
|
+
secure: true;
|
|
13379
|
+
apiPath: '.launchExternalProcess';
|
|
13380
|
+
namespace: 'System';
|
|
13381
|
+
};
|
|
13313
13382
|
'monitor-external-process': ApiCall<OpenFin.ExternalProcessInfo, OpenFin.Identity>;
|
|
13314
13383
|
'write-to-log': ApiCall<{
|
|
13315
13384
|
level: string;
|
|
@@ -13317,25 +13386,48 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13317
13386
|
}, void>;
|
|
13318
13387
|
'open-url-with-browser': ApiCall<{
|
|
13319
13388
|
url: string;
|
|
13320
|
-
}, void
|
|
13321
|
-
|
|
13389
|
+
}, void> & {
|
|
13390
|
+
secure: true;
|
|
13391
|
+
apiPath: '.openUrlWithBrowser';
|
|
13392
|
+
namespace: 'System';
|
|
13393
|
+
};
|
|
13394
|
+
'register-custom-protocol': ApiCall<OpenFin.CustomProtocolOptions, void> & {
|
|
13395
|
+
secure: true;
|
|
13396
|
+
apiPath: '.registerCustomProtocol';
|
|
13397
|
+
namespace: 'System';
|
|
13398
|
+
};
|
|
13322
13399
|
'unregister-custom-protocol': ApiCall<{
|
|
13323
13400
|
protocolName: string;
|
|
13324
|
-
}, void
|
|
13401
|
+
}, void> & {
|
|
13402
|
+
secure: true;
|
|
13403
|
+
apiPath: '.unregisterCustomProtocol';
|
|
13404
|
+
namespace: 'System';
|
|
13405
|
+
};
|
|
13325
13406
|
'get-custom-protocol-state': ApiCall<{
|
|
13326
13407
|
protocolName: string;
|
|
13327
|
-
}, OpenFin.CustomProtocolState
|
|
13408
|
+
}, OpenFin.CustomProtocolState> & {
|
|
13409
|
+
secure: true;
|
|
13410
|
+
apiPath: '.getCustomProtocolState';
|
|
13411
|
+
namespace: 'System';
|
|
13412
|
+
};
|
|
13328
13413
|
'release-external-process': ApiCall<{
|
|
13329
13414
|
uuid: string;
|
|
13330
13415
|
}, void>;
|
|
13331
13416
|
'show-developer-tools': ApiCall<OpenFin.Identity, void>;
|
|
13332
|
-
'terminate-external-process': ApiCall<OpenFin.TerminateExternalRequestType, void
|
|
13417
|
+
'terminate-external-process': ApiCall<OpenFin.TerminateExternalRequestType, void> & {
|
|
13418
|
+
secure: true;
|
|
13419
|
+
apiPath: '.terminateExternalProcess';
|
|
13420
|
+
namespace: 'System';
|
|
13421
|
+
};
|
|
13333
13422
|
'update-proxy': ApiCall<OpenFin.ProxyConfig, void>;
|
|
13334
13423
|
'download-asset': {
|
|
13335
13424
|
request: OpenFin.AppAssetInfo & {
|
|
13336
13425
|
downloadId: string;
|
|
13337
13426
|
};
|
|
13338
13427
|
response: void;
|
|
13428
|
+
secure: true;
|
|
13429
|
+
apiPath: '.downloadAsset';
|
|
13430
|
+
namespace: 'System';
|
|
13339
13431
|
};
|
|
13340
13432
|
'download-runtime': {
|
|
13341
13433
|
request: OpenFin.RuntimeDownloadOptions & {
|
|
@@ -13364,7 +13456,11 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13364
13456
|
rootKey: string;
|
|
13365
13457
|
subkey: string;
|
|
13366
13458
|
value: string;
|
|
13367
|
-
}, OpenFin.RegistryInfo
|
|
13459
|
+
}, OpenFin.RegistryInfo> & {
|
|
13460
|
+
secure: true;
|
|
13461
|
+
apiPath: '.readRegistryValue';
|
|
13462
|
+
namespace: 'System';
|
|
13463
|
+
};
|
|
13368
13464
|
'register-external-connection': ApiCall<{
|
|
13369
13465
|
uuid: string;
|
|
13370
13466
|
}, OpenFin.ExternalConnection>;
|
|
@@ -13398,26 +13494,48 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13398
13494
|
permissions: any;
|
|
13399
13495
|
};
|
|
13400
13496
|
response: OpenFin.NativeWindowIntegrationProviderAuthorization;
|
|
13497
|
+
secure: true;
|
|
13498
|
+
apiPath: '.enableNativeWindowIntegrationProvider';
|
|
13499
|
+
namespace: 'System';
|
|
13401
13500
|
};
|
|
13402
13501
|
'register-usage': ApiCall<OpenFin.RegisterUsageData, void>;
|
|
13403
13502
|
'system-get-printers': GetterCall<OpenFin.PrinterInfo[]>;
|
|
13404
13503
|
'system-update-process-logging-options': ApiCall<{
|
|
13405
13504
|
options: OpenFin.ProcessLoggingOptions;
|
|
13406
13505
|
}, void>;
|
|
13407
|
-
'get-domain-settings': ApiCall<void, OpenFin.DomainSettings
|
|
13506
|
+
'get-domain-settings': ApiCall<void, OpenFin.DomainSettings> & {
|
|
13507
|
+
secure: true;
|
|
13508
|
+
apiPath: '.getDomainSettings';
|
|
13509
|
+
namespace: 'System';
|
|
13510
|
+
};
|
|
13408
13511
|
'serve-asset': ApiCall<{
|
|
13409
13512
|
options: OpenFin.ServeAssetOptions;
|
|
13410
|
-
}, OpenFin.ServedAssetInfo
|
|
13513
|
+
}, OpenFin.ServedAssetInfo> & {
|
|
13514
|
+
secure: true;
|
|
13515
|
+
apiPath: '.serveAsset';
|
|
13516
|
+
namespace: 'System';
|
|
13517
|
+
};
|
|
13411
13518
|
'set-domain-settings': ApiCall<{
|
|
13412
13519
|
domainSettings: OpenFin.DomainSettings;
|
|
13413
|
-
}, void
|
|
13520
|
+
}, void> & {
|
|
13521
|
+
secure: true;
|
|
13522
|
+
apiPath: '.setDomainSettings';
|
|
13523
|
+
namespace: 'System';
|
|
13524
|
+
};
|
|
13414
13525
|
'get-current-domain-settings': ApiCall<{
|
|
13415
13526
|
identity: OpenFin.Identity;
|
|
13416
|
-
}, OpenFin.ResolvedDomainSettings
|
|
13527
|
+
}, OpenFin.ResolvedDomainSettings> & {
|
|
13528
|
+
secure: true;
|
|
13529
|
+
apiPath: '.getCurrentDomainSettings';
|
|
13530
|
+
namespace: 'System';
|
|
13531
|
+
};
|
|
13417
13532
|
'resolve-domain-settings': ApiCall<{
|
|
13418
13533
|
url: string;
|
|
13419
|
-
}, OpenFin.ResolvedDomainSettings
|
|
13420
|
-
|
|
13534
|
+
}, OpenFin.ResolvedDomainSettings> & {
|
|
13535
|
+
secure: true;
|
|
13536
|
+
apiPath: '.resolveDomainSettings';
|
|
13537
|
+
namespace: 'System';
|
|
13538
|
+
};
|
|
13421
13539
|
'get-permissions': GetterCall<any>;
|
|
13422
13540
|
'refresh-extensions': {
|
|
13423
13541
|
request: void;
|
|
@@ -13427,24 +13545,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13427
13545
|
request: void;
|
|
13428
13546
|
response: OpenFin.ExtensionInfo[];
|
|
13429
13547
|
};
|
|
13430
|
-
'fdc3-add-context-listener': VoidCall;
|
|
13431
|
-
'fdc3-add-intent-listener': VoidCall;
|
|
13432
|
-
'fdc3-raise-intent': VoidCall;
|
|
13433
|
-
'fdc3-find-intent': VoidCall;
|
|
13434
|
-
'fdc3-find-intents-by-context': VoidCall;
|
|
13435
|
-
'fdc3-raise-intent-for-context': VoidCall;
|
|
13436
|
-
'fdc3-get-info': VoidCall;
|
|
13437
|
-
'fdc3-find-instances': VoidCall;
|
|
13438
|
-
'fdc3-get-app-metadata': VoidCall;
|
|
13439
|
-
'fdc3-broadcast': VoidCall;
|
|
13440
|
-
'fdc3-open': VoidCall;
|
|
13441
|
-
'fdc3-get-or-create-channel': VoidCall;
|
|
13442
|
-
'fdc3-get-system-channels': VoidCall;
|
|
13443
|
-
'fdc3-join-channel': VoidCall;
|
|
13444
|
-
'fdc3-get-current-channel': VoidCall;
|
|
13445
|
-
'fdc3-leave-current-channel': VoidCall;
|
|
13446
|
-
'interop-init': VoidCall;
|
|
13447
|
-
'interop-connect-sync': VoidCall;
|
|
13448
13548
|
'interop-client-set-context': VoidCall;
|
|
13449
13549
|
'interop-client-add-context-handler': VoidCall;
|
|
13450
13550
|
'interop-client-get-context-groups': VoidCall;
|
|
@@ -13475,12 +13575,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13475
13575
|
'interop-session-context-group-set-context': VoidCall;
|
|
13476
13576
|
'interop-session-context-group-get-context': VoidCall;
|
|
13477
13577
|
'interop-session-context-group-add-handler': VoidCall;
|
|
13478
|
-
'platform-wrap': VoidCall;
|
|
13479
|
-
'platform-wrap-sync': VoidCall;
|
|
13480
|
-
'platform-get-current': VoidCall;
|
|
13481
|
-
'platform-get-current-sync': VoidCall;
|
|
13482
|
-
'platform-start': VoidCall;
|
|
13483
|
-
'platform-start-from-manifest': VoidCall;
|
|
13484
13578
|
'platform-get-client': ApplicationIdentityCall<{}, void>;
|
|
13485
13579
|
'platform-create-view': ApplicationIdentityCall<{}, void>;
|
|
13486
13580
|
'platform-create-window': ApplicationIdentityCall<{}, void>;
|
|
@@ -13493,11 +13587,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13493
13587
|
'platform-set-window-context': ApplicationIdentityCall<{}, void>;
|
|
13494
13588
|
'platform-get-window-context': ApplicationIdentityCall<{}, void>;
|
|
13495
13589
|
'platform-close-window': ApplicationIdentityCall<{}, void>;
|
|
13496
|
-
'layout-wrap': VoidCall;
|
|
13497
|
-
'layout-wrap-sync': VoidCall;
|
|
13498
|
-
'layout-get-current': VoidCall;
|
|
13499
|
-
'layout-get-current-sync': VoidCall;
|
|
13500
|
-
'layout-init': VoidCall;
|
|
13501
13590
|
'layout-get-config': VoidCall;
|
|
13502
13591
|
'layout-get-views': VoidCall;
|
|
13503
13592
|
'layout-replace': VoidCall;
|
|
@@ -13516,12 +13605,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13516
13605
|
'layout-controller-create-adjacent-stack': VoidCall;
|
|
13517
13606
|
'layout-controller-get-adjacent-stacks': VoidCall;
|
|
13518
13607
|
'layout-controller-set-stack-active-view': VoidCall;
|
|
13519
|
-
'snapshot-source-init': VoidCall;
|
|
13520
|
-
'snapshot-source-wrap-sync': VoidCall;
|
|
13521
|
-
'snapshot-source-wrap': VoidCall;
|
|
13522
|
-
'snapshot-source-ready': VoidCall;
|
|
13523
|
-
'snapshot-source-get-snapshot': VoidCall;
|
|
13524
|
-
'snapshot-source-apply-snapshot': VoidCall;
|
|
13525
13608
|
'capture-page': IdentityCall<{
|
|
13526
13609
|
options?: OpenFin.CapturePageOptions;
|
|
13527
13610
|
}, string>;
|
|
@@ -13602,15 +13685,27 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
13602
13685
|
};
|
|
13603
13686
|
response: void;
|
|
13604
13687
|
};
|
|
13605
|
-
|
|
13606
|
-
|
|
13607
|
-
|
|
13608
|
-
|
|
13609
|
-
|
|
13610
|
-
|
|
13611
|
-
|
|
13688
|
+
'subscribe-to-desktop-event': {
|
|
13689
|
+
request: {
|
|
13690
|
+
topic: string;
|
|
13691
|
+
type: string;
|
|
13692
|
+
uuid?: string;
|
|
13693
|
+
name?: string;
|
|
13694
|
+
timestamp?: number;
|
|
13695
|
+
};
|
|
13696
|
+
response: void;
|
|
13612
13697
|
};
|
|
13613
|
-
|
|
13698
|
+
'unsubscribe-to-desktop-event': {
|
|
13699
|
+
request: {
|
|
13700
|
+
topic: string;
|
|
13701
|
+
type: string;
|
|
13702
|
+
uuid?: string;
|
|
13703
|
+
name?: string;
|
|
13704
|
+
timestamp?: number;
|
|
13705
|
+
};
|
|
13706
|
+
response: void;
|
|
13707
|
+
};
|
|
13708
|
+
};
|
|
13614
13709
|
|
|
13615
13710
|
declare type ProtocolOffer = ClassicProtocolOffer | RTCProtocolOffer;
|
|
13616
13711
|
|
|
@@ -14176,7 +14271,9 @@ declare type SecurityRealmEvent = BaseEvent_9 & {
|
|
|
14176
14271
|
|
|
14177
14272
|
declare type SendActionResponse<T extends keyof ProtocolMap> = Message<{
|
|
14178
14273
|
data: ProtocolMap[T]['response'];
|
|
14179
|
-
} & ProtocolMap[T]
|
|
14274
|
+
} & (ProtocolMap[T] extends {
|
|
14275
|
+
specialResponse: infer U;
|
|
14276
|
+
} ? U : {})>;
|
|
14180
14277
|
|
|
14181
14278
|
/**
|
|
14182
14279
|
* @interface
|
|
@@ -14691,13 +14788,15 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14691
14788
|
* * cookies: browser [cookies](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies)
|
|
14692
14789
|
* * localStorage: browser data that can be used across sessions ([local storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage))
|
|
14693
14790
|
* * appcache: html5 [application cache](https://developer.mozilla.org/en-US/docs/Web/HTML/Using_the_application_cache)
|
|
14791
|
+
* * windowState: clears data written for windows using `saveWindowState`; after clearing, previously saved bounds and state will not be restored until new state is written
|
|
14694
14792
|
* @example
|
|
14695
14793
|
* ```js
|
|
14696
14794
|
* const clearCacheOptions = {
|
|
14697
14795
|
* appcache: true,
|
|
14698
14796
|
* cache: true,
|
|
14699
14797
|
* cookies: true,
|
|
14700
|
-
* localStorage: true
|
|
14798
|
+
* localStorage: true,
|
|
14799
|
+
* windowState: true
|
|
14701
14800
|
* };
|
|
14702
14801
|
* fin.System.clearCache(clearCacheOptions).then(() => console.log('Cache cleared')).catch(err => console.log(err));
|
|
14703
14802
|
* ```
|
|
@@ -16195,7 +16294,6 @@ declare type SystemEventType = EventType_8;
|
|
|
16195
16294
|
*/
|
|
16196
16295
|
declare type SystemPermissions = {
|
|
16197
16296
|
getOSInfo: boolean;
|
|
16198
|
-
getAllExternalWindows: boolean;
|
|
16199
16297
|
setDomainSettings: boolean;
|
|
16200
16298
|
getDomainSettings: boolean;
|
|
16201
16299
|
getCurrentDomainSettings: boolean;
|
|
@@ -16235,6 +16333,10 @@ declare type SystemPermissions = {
|
|
|
16235
16333
|
enabled: boolean;
|
|
16236
16334
|
protocols: string[];
|
|
16237
16335
|
};
|
|
16336
|
+
getInstalledApps: boolean;
|
|
16337
|
+
downloadAsset: boolean;
|
|
16338
|
+
serveAsset: boolean;
|
|
16339
|
+
enableNativeWindowIntegrationProvider: boolean;
|
|
16238
16340
|
};
|
|
16239
16341
|
|
|
16240
16342
|
/**
|
|
@@ -16543,9 +16645,12 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
|
|
|
16543
16645
|
sendRaw: Wire['send'];
|
|
16544
16646
|
eventAggregator: EventAggregator;
|
|
16545
16647
|
protected messageHandlers: MessageHandler[];
|
|
16546
|
-
constructor(factory: WireFactory, environment: Environment, config: OpenFin.Identity
|
|
16648
|
+
constructor(factory: WireFactory, environment: Environment, config: OpenFin.Identity & {
|
|
16649
|
+
apiDiagnostics?: boolean;
|
|
16650
|
+
});
|
|
16547
16651
|
getFin(): OpenFin.Fin<MeType>;
|
|
16548
16652
|
registerFin(_fin: OpenFin.Fin<MeType>): void;
|
|
16653
|
+
recordAnalytic(action: string): void;
|
|
16549
16654
|
connectSync: () => void;
|
|
16550
16655
|
getPort: () => string;
|
|
16551
16656
|
shutdown(): Promise<void>;
|
|
@@ -16553,7 +16658,7 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
|
|
|
16553
16658
|
private connectRemote;
|
|
16554
16659
|
connectByPort(config: ExistingConnectConfig): Promise<void>;
|
|
16555
16660
|
private authorize;
|
|
16556
|
-
sendAction<T extends keyof ProtocolMap
|
|
16661
|
+
sendAction<T extends keyof ProtocolMap>(action: T, payload?: ProtocolMap[T]['request'], uncorrelated?: boolean): SentMessage<SendActionResponse<T>>;
|
|
16557
16662
|
protected nackHandler(payloadOrMessage: RuntimeErrorPayload | string, reject: Function, callSites?: NodeJS.CallSite[]): void;
|
|
16558
16663
|
ferryAction(origData: any): Promise<Message<any>>;
|
|
16559
16664
|
registerMessageHandler(handler: MessageHandler): void;
|