@openfin/fdc3-api 45.100.51 → 45.100.56
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 +135 -61
- package/out/fdc3-api-beta.d.ts +135 -61
- package/out/fdc3-api-public.d.ts +135 -61
- package/out/fdc3-api.d.ts +135 -61
- package/out/fdc3-api.js +22 -66
- package/package.json +1 -1
package/out/fdc3-api-public.d.ts
CHANGED
|
@@ -85,7 +85,7 @@ declare type AlertRequestedEvent = BaseEvent_5 & {
|
|
|
85
85
|
url: string;
|
|
86
86
|
};
|
|
87
87
|
|
|
88
|
-
declare type AnalyticsOnlyCalls = '
|
|
88
|
+
declare type AnalyticsOnlyCalls = 'layout-get-stack-by-view' | 'layout-add-view' | 'layout-close-view' | `layout-controller-${string}`;
|
|
89
89
|
|
|
90
90
|
declare type AnalyticsProtocolMap = {
|
|
91
91
|
[k in AnalyticsOnlyCalls]: VoidCall;
|
|
@@ -1754,6 +1754,7 @@ declare type BaseConfig = {
|
|
|
1754
1754
|
devToolsPort?: number;
|
|
1755
1755
|
installerUI?: boolean;
|
|
1756
1756
|
runtime?: RuntimeConfig;
|
|
1757
|
+
apiDiagnostics?: boolean;
|
|
1757
1758
|
appAssets?: [
|
|
1758
1759
|
{
|
|
1759
1760
|
src: string;
|
|
@@ -6985,6 +6986,16 @@ declare type IntentMetadata<TargetType = any> = {
|
|
|
6985
6986
|
*/
|
|
6986
6987
|
declare class InterApplicationBus extends Base {
|
|
6987
6988
|
Channel: Channel;
|
|
6989
|
+
/**
|
|
6990
|
+
* Event types for the InterApplicationBus.
|
|
6991
|
+
*
|
|
6992
|
+
* @remarks The `subscriber-added` and `subscriber-removed` events are disabled by default.
|
|
6993
|
+
* To re-enable them, launch the runtime with the `--emit-legacy-iab-events` flag.
|
|
6994
|
+
* These events will be removed in a future version. Use {@link Channel} for connection
|
|
6995
|
+
* lifecycle management instead.
|
|
6996
|
+
*
|
|
6997
|
+
* @deprecated Use {@link Channel} `onConnection` / `onDisconnection` instead.
|
|
6998
|
+
*/
|
|
6988
6999
|
events: {
|
|
6989
7000
|
subscriberAdded: string;
|
|
6990
7001
|
subscriberRemoved: string;
|
|
@@ -10659,6 +10670,9 @@ declare namespace OpenFin {
|
|
|
10659
10670
|
SystemProcessInfo,
|
|
10660
10671
|
ClearCacheOption,
|
|
10661
10672
|
ClearDataOptions,
|
|
10673
|
+
TraceConfig,
|
|
10674
|
+
TraceCategoriesAndOptions,
|
|
10675
|
+
TraceBufferUsage,
|
|
10662
10676
|
CookieInfo,
|
|
10663
10677
|
CookieOption,
|
|
10664
10678
|
CrashReporterOptions,
|
|
@@ -13249,19 +13263,17 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
13249
13263
|
response: OpenFin.MenuResult;
|
|
13250
13264
|
};
|
|
13251
13265
|
'close-tray-icon-popup-menu': IdentityCall<{}, void>;
|
|
13252
|
-
'wrap-application': VoidCall;
|
|
13253
|
-
'wrap-application-sync': VoidCall;
|
|
13254
13266
|
'create-application': ApiCall<OpenFin.ApplicationCreationOptions, void>;
|
|
13255
|
-
'application-create': VoidCall;
|
|
13256
|
-
'start-application': VoidCall;
|
|
13257
13267
|
'run-applications': ApiCall<{
|
|
13258
13268
|
applications: Array<OpenFin.ManifestInfo>;
|
|
13259
13269
|
opts?: OpenFin.RvmLaunchOptions;
|
|
13260
13270
|
}, void>;
|
|
13261
|
-
'
|
|
13262
|
-
|
|
13263
|
-
|
|
13264
|
-
|
|
13271
|
+
'send-analytics-batch': {
|
|
13272
|
+
request: {
|
|
13273
|
+
counts: Record<string, number>;
|
|
13274
|
+
};
|
|
13275
|
+
response: void;
|
|
13276
|
+
};
|
|
13265
13277
|
'request-external-authorization': {
|
|
13266
13278
|
request: any;
|
|
13267
13279
|
response: void;
|
|
@@ -13380,10 +13392,6 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
13380
13392
|
options: OpenFin.UpdatableViewOptions;
|
|
13381
13393
|
}>;
|
|
13382
13394
|
'trigger-before-unload': IdentityCall<{}, boolean>;
|
|
13383
|
-
'view-wrap-sync': VoidCall;
|
|
13384
|
-
'view-wrap': VoidCall;
|
|
13385
|
-
'view-get-current': VoidCall;
|
|
13386
|
-
'view-get-current-sync': VoidCall;
|
|
13387
13395
|
'animate-window': IdentityCall<{
|
|
13388
13396
|
transitions: OpenFin.Transition;
|
|
13389
13397
|
options: OpenFin.TransitionOptions;
|
|
@@ -13475,11 +13483,6 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
13475
13483
|
};
|
|
13476
13484
|
response: void;
|
|
13477
13485
|
};
|
|
13478
|
-
'window-wrap': VoidCall;
|
|
13479
|
-
'window-wrap-sync': VoidCall;
|
|
13480
|
-
'create-window': VoidCall;
|
|
13481
|
-
'get-current-window': VoidCall;
|
|
13482
|
-
'get-current-window-sync': VoidCall;
|
|
13483
13486
|
'show-download-bubble': IdentityCall<{
|
|
13484
13487
|
anchor?: OpenFin.Anchor;
|
|
13485
13488
|
}, void>;
|
|
@@ -13487,14 +13490,8 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
13487
13490
|
anchor: OpenFin.Anchor;
|
|
13488
13491
|
}, void>;
|
|
13489
13492
|
'get-external-application-info': ApiCall<OpenFin.ApplicationIdentity, OpenFin.ExternalApplicationInfo>;
|
|
13490
|
-
'external-application-wrap': VoidCall;
|
|
13491
|
-
'external-application-wrap-sync': VoidCall;
|
|
13492
13493
|
'get-frame-info': ApiCall<OpenFin.Identity, OpenFin.FrameInfo>;
|
|
13493
13494
|
'get-parent-window': ApiCall<OpenFin.Identity, OpenFin.FrameInfo>;
|
|
13494
|
-
'frame-wrap': VoidCall;
|
|
13495
|
-
'frame-wrap-sync': VoidCall;
|
|
13496
|
-
'frame-get-current': VoidCall;
|
|
13497
|
-
'frame-get-current-sync': VoidCall;
|
|
13498
13495
|
'global-hotkey-register': {
|
|
13499
13496
|
request: {
|
|
13500
13497
|
hotkey: string;
|
|
@@ -13587,6 +13584,12 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
13587
13584
|
}, OpenFin.NativeTheme>;
|
|
13588
13585
|
'get-theme-preferences': GetterCall<OpenFin.NativeTheme>;
|
|
13589
13586
|
'get-version': GetterCall<string>;
|
|
13587
|
+
'content-tracing-get-categories': GetterCall<string[]>;
|
|
13588
|
+
'content-tracing-start-recording': ApiCall<{
|
|
13589
|
+
options: OpenFin.TraceConfig | OpenFin.TraceCategoriesAndOptions;
|
|
13590
|
+
}, void>;
|
|
13591
|
+
'content-tracing-stop-recording': GetterCall<string>;
|
|
13592
|
+
'content-tracing-get-trace-buffer-usage': GetterCall<OpenFin.TraceBufferUsage>;
|
|
13590
13593
|
'clear-cache': ApiCall<OpenFin.ClearCacheOption, void>;
|
|
13591
13594
|
'clear-http-cache': VoidCall;
|
|
13592
13595
|
'clear-cache-data': ApiCall<OpenFin.ClearDataOptions, void>;
|
|
@@ -13831,7 +13834,6 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
13831
13834
|
apiPath: '.resolveDomainSettings';
|
|
13832
13835
|
namespace: 'System';
|
|
13833
13836
|
};
|
|
13834
|
-
'system-register-shutdown-handler': VoidCall;
|
|
13835
13837
|
'get-permissions': GetterCall<any>;
|
|
13836
13838
|
'refresh-extensions': {
|
|
13837
13839
|
request: void;
|
|
@@ -13850,24 +13852,6 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
13850
13852
|
request: void;
|
|
13851
13853
|
response: Array<OpenFin.ThemePalette>;
|
|
13852
13854
|
};
|
|
13853
|
-
'fdc3-add-context-listener': VoidCall;
|
|
13854
|
-
'fdc3-add-intent-listener': VoidCall;
|
|
13855
|
-
'fdc3-raise-intent': VoidCall;
|
|
13856
|
-
'fdc3-find-intent': VoidCall;
|
|
13857
|
-
'fdc3-find-intents-by-context': VoidCall;
|
|
13858
|
-
'fdc3-raise-intent-for-context': VoidCall;
|
|
13859
|
-
'fdc3-get-info': VoidCall;
|
|
13860
|
-
'fdc3-find-instances': VoidCall;
|
|
13861
|
-
'fdc3-get-app-metadata': VoidCall;
|
|
13862
|
-
'fdc3-broadcast': VoidCall;
|
|
13863
|
-
'fdc3-open': VoidCall;
|
|
13864
|
-
'fdc3-get-or-create-channel': VoidCall;
|
|
13865
|
-
'fdc3-get-system-channels': VoidCall;
|
|
13866
|
-
'fdc3-join-channel': VoidCall;
|
|
13867
|
-
'fdc3-get-current-channel': VoidCall;
|
|
13868
|
-
'fdc3-leave-current-channel': VoidCall;
|
|
13869
|
-
'interop-init': VoidCall;
|
|
13870
|
-
'interop-connect-sync': VoidCall;
|
|
13871
13855
|
'interop-client-set-context': VoidCall;
|
|
13872
13856
|
'interop-client-add-context-handler': VoidCall;
|
|
13873
13857
|
'interop-client-get-context-groups': VoidCall;
|
|
@@ -13898,12 +13882,6 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
13898
13882
|
'interop-session-context-group-set-context': VoidCall;
|
|
13899
13883
|
'interop-session-context-group-get-context': VoidCall;
|
|
13900
13884
|
'interop-session-context-group-add-handler': VoidCall;
|
|
13901
|
-
'platform-wrap': VoidCall;
|
|
13902
|
-
'platform-wrap-sync': VoidCall;
|
|
13903
|
-
'platform-get-current': VoidCall;
|
|
13904
|
-
'platform-get-current-sync': VoidCall;
|
|
13905
|
-
'platform-start': VoidCall;
|
|
13906
|
-
'platform-start-from-manifest': VoidCall;
|
|
13907
13885
|
'platform-get-client': ApplicationIdentityCall<{}, void>;
|
|
13908
13886
|
'platform-create-view': ApplicationIdentityCall<{}, void>;
|
|
13909
13887
|
'platform-create-window': ApplicationIdentityCall<{}, void>;
|
|
@@ -13916,11 +13894,6 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
13916
13894
|
'platform-set-window-context': ApplicationIdentityCall<{}, void>;
|
|
13917
13895
|
'platform-get-window-context': ApplicationIdentityCall<{}, void>;
|
|
13918
13896
|
'platform-close-window': ApplicationIdentityCall<{}, void>;
|
|
13919
|
-
'layout-wrap': VoidCall;
|
|
13920
|
-
'layout-wrap-sync': VoidCall;
|
|
13921
|
-
'layout-get-current': VoidCall;
|
|
13922
|
-
'layout-get-current-sync': VoidCall;
|
|
13923
|
-
'layout-init': VoidCall;
|
|
13924
13897
|
'layout-get-config': VoidCall;
|
|
13925
13898
|
'layout-get-views': VoidCall;
|
|
13926
13899
|
'layout-replace': VoidCall;
|
|
@@ -13939,12 +13912,6 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
13939
13912
|
'layout-controller-create-adjacent-stack': VoidCall;
|
|
13940
13913
|
'layout-controller-get-adjacent-stacks': VoidCall;
|
|
13941
13914
|
'layout-controller-set-stack-active-view': VoidCall;
|
|
13942
|
-
'snapshot-source-init': VoidCall;
|
|
13943
|
-
'snapshot-source-wrap-sync': VoidCall;
|
|
13944
|
-
'snapshot-source-wrap': VoidCall;
|
|
13945
|
-
'snapshot-source-ready': VoidCall;
|
|
13946
|
-
'snapshot-source-get-snapshot': VoidCall;
|
|
13947
|
-
'snapshot-source-apply-snapshot': VoidCall;
|
|
13948
13915
|
'capture-page': IdentityCall<{
|
|
13949
13916
|
options?: OpenFin.CapturePageOptions;
|
|
13950
13917
|
}, string>;
|
|
@@ -15176,6 +15143,10 @@ declare type SubscriptionOptions = {
|
|
|
15176
15143
|
*
|
|
15177
15144
|
*/
|
|
15178
15145
|
declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
15146
|
+
/**
|
|
15147
|
+
* Chromium content tracing APIs.
|
|
15148
|
+
*/
|
|
15149
|
+
readonly ContentTracing: SystemContentTracing;
|
|
15179
15150
|
/* Excluded from this release type: __constructor */
|
|
15180
15151
|
private sendExternalProcessRequest;
|
|
15181
15152
|
/**
|
|
@@ -16809,6 +16780,36 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
16809
16780
|
getThemePalette(): Promise<Array<OpenFin.ThemePalette>>;
|
|
16810
16781
|
}
|
|
16811
16782
|
|
|
16783
|
+
/**
|
|
16784
|
+
* Chromium content tracing APIs exposed under `fin.System.ContentTracing`.
|
|
16785
|
+
*/
|
|
16786
|
+
declare class SystemContentTracing extends Base {
|
|
16787
|
+
/**
|
|
16788
|
+
* Gets the currently known tracing category groups.
|
|
16789
|
+
*/
|
|
16790
|
+
getCategories(): Promise<string[]>;
|
|
16791
|
+
/**
|
|
16792
|
+
* Starts content tracing across runtime processes.
|
|
16793
|
+
*
|
|
16794
|
+
* Only one content tracing session may be active across the runtime at a time.
|
|
16795
|
+
* This method rejects if another identity already owns the active session.
|
|
16796
|
+
*/
|
|
16797
|
+
startRecording(options: OpenFin.TraceConfig | OpenFin.TraceCategoriesAndOptions): Promise<void>;
|
|
16798
|
+
/**
|
|
16799
|
+
* Stops the active content tracing session and writes the trace to the runtime-managed cache folder.
|
|
16800
|
+
*
|
|
16801
|
+
* The calling identity must match the identity that started the active tracing session.
|
|
16802
|
+
* This method rejects if tracing is not active or is owned by another identity.
|
|
16803
|
+
*/
|
|
16804
|
+
stopRecording(): Promise<string>;
|
|
16805
|
+
/**
|
|
16806
|
+
* Returns the current maximum trace buffer usage across processes.
|
|
16807
|
+
*
|
|
16808
|
+
* This method is not supported on macOS and rejects on that platform.
|
|
16809
|
+
*/
|
|
16810
|
+
getTraceBufferUsage(): Promise<OpenFin.TraceBufferUsage>;
|
|
16811
|
+
}
|
|
16812
|
+
|
|
16812
16813
|
/**
|
|
16813
16814
|
* @deprecated Renamed to {@link Event}.
|
|
16814
16815
|
*/
|
|
@@ -17248,6 +17249,76 @@ declare type Time = {
|
|
|
17248
17249
|
|
|
17249
17250
|
declare type TimeZones = 'utc' | 'local';
|
|
17250
17251
|
|
|
17252
|
+
/**
|
|
17253
|
+
* @interface
|
|
17254
|
+
* Current maximum usage across trace buffers.
|
|
17255
|
+
*/
|
|
17256
|
+
declare type TraceBufferUsage = {
|
|
17257
|
+
value: number;
|
|
17258
|
+
percentage: number;
|
|
17259
|
+
};
|
|
17260
|
+
|
|
17261
|
+
/**
|
|
17262
|
+
* @interface
|
|
17263
|
+
* Shorthand tracing configuration based on Electron's contentTracing.startRecording() API.
|
|
17264
|
+
*/
|
|
17265
|
+
declare type TraceCategoriesAndOptions = {
|
|
17266
|
+
/**
|
|
17267
|
+
* Filter that controls which category groups should be traced.
|
|
17268
|
+
* A filter can have an optional '-' prefix to exclude category groups that contain a matching category. Having both included and excluded category patterns in the same list is not supported. Examples: test_MyTest*, test_MyTest*,test_OtherStuff, -excluded_category1,-excluded_category2.
|
|
17269
|
+
*/
|
|
17270
|
+
categoryFilter: string;
|
|
17271
|
+
/**
|
|
17272
|
+
* Comma-delimited string controlling recording mode and extra trace options. valid strings; record-until-full, record-continuously, trace-to-console, enable-sampling, enable-systrace, e.g. 'record-until-full,enable-sampling'. The first 3 options are trace recording modes and hence mutually exclusive. If more than one trace recording modes appear in the traceOptions string, the last one takes precedence. If none of the trace recording modes are specified, recording mode is record-until-full. The trace option will first be reset to the default option (record_mode set to record-until-full, enable_sampling and enable_systrace set to false) before options parsed from traceOptions are applied on it.
|
|
17273
|
+
*/
|
|
17274
|
+
traceOptions: string;
|
|
17275
|
+
};
|
|
17276
|
+
|
|
17277
|
+
/**
|
|
17278
|
+
* @interface
|
|
17279
|
+
* Structured tracing configuration based on Electron's contentTracing.startRecording() API.
|
|
17280
|
+
*/
|
|
17281
|
+
declare type TraceConfig = {
|
|
17282
|
+
/**
|
|
17283
|
+
* Can be `record-until-full`, `record-continuously`, `record-as-much-as-possible` or `trace-to-console`.
|
|
17284
|
+
* Defaults to `record-until-full`, which will record until the trace buffer is full and then stop recording.
|
|
17285
|
+
*/
|
|
17286
|
+
recording_mode?: 'record-until-full' | 'record-continuously' | 'record-as-much-as-possible' | 'trace-to-console';
|
|
17287
|
+
/**
|
|
17288
|
+
* Maximum size of the trace recording buffer in kilobytes.
|
|
17289
|
+
*/
|
|
17290
|
+
trace_buffer_size_in_kb?: number;
|
|
17291
|
+
/**
|
|
17292
|
+
* Maximum size of the trace recording buffer in events.
|
|
17293
|
+
* Defaults to 100MB
|
|
17294
|
+
*/
|
|
17295
|
+
trace_buffer_size_in_events?: number;
|
|
17296
|
+
/**
|
|
17297
|
+
* Filters event data according to Chromium's vetted allowlist.
|
|
17298
|
+
*/
|
|
17299
|
+
enable_argument_filter?: boolean;
|
|
17300
|
+
/**
|
|
17301
|
+
* A list of tracing categories to include.
|
|
17302
|
+
*/
|
|
17303
|
+
included_categories?: string[];
|
|
17304
|
+
/**
|
|
17305
|
+
* A list of tracing categories to exclude.
|
|
17306
|
+
*/
|
|
17307
|
+
excluded_categories?: string[];
|
|
17308
|
+
/**
|
|
17309
|
+
* A list of process IDs to include in the trace.
|
|
17310
|
+
*/
|
|
17311
|
+
included_process_ids?: number[];
|
|
17312
|
+
/**
|
|
17313
|
+
* A list of histogram names to report with the trace.
|
|
17314
|
+
*/
|
|
17315
|
+
histogram_names?: string[];
|
|
17316
|
+
/**
|
|
17317
|
+
* Additional configuration for memory tracing when memory-infra tracing is enabled.
|
|
17318
|
+
*/
|
|
17319
|
+
memory_dump_config?: Record<string, any>;
|
|
17320
|
+
};
|
|
17321
|
+
|
|
17251
17322
|
/**
|
|
17252
17323
|
* @interface
|
|
17253
17324
|
*/
|
|
@@ -17316,9 +17387,12 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
|
|
|
17316
17387
|
sendRaw: Wire['send'];
|
|
17317
17388
|
eventAggregator: EventAggregator;
|
|
17318
17389
|
protected messageHandlers: MessageHandler[];
|
|
17319
|
-
constructor(factory: WireFactory, environment: Environment, config: OpenFin.Identity
|
|
17390
|
+
constructor(factory: WireFactory, environment: Environment, config: OpenFin.Identity & {
|
|
17391
|
+
apiDiagnostics?: boolean;
|
|
17392
|
+
});
|
|
17320
17393
|
getFin(): OpenFin.Fin<MeType>;
|
|
17321
17394
|
registerFin(_fin: OpenFin.Fin<MeType>): void;
|
|
17395
|
+
recordAnalytic(action: string): void;
|
|
17322
17396
|
connectSync: () => void;
|
|
17323
17397
|
getPort: () => string;
|
|
17324
17398
|
shutdown(): Promise<void>;
|
package/out/fdc3-api.d.ts
CHANGED
|
@@ -85,7 +85,7 @@ declare type AlertRequestedEvent = BaseEvent_5 & {
|
|
|
85
85
|
url: string;
|
|
86
86
|
};
|
|
87
87
|
|
|
88
|
-
declare type AnalyticsOnlyCalls = '
|
|
88
|
+
declare type AnalyticsOnlyCalls = 'layout-get-stack-by-view' | 'layout-add-view' | 'layout-close-view' | `layout-controller-${string}`;
|
|
89
89
|
|
|
90
90
|
declare type AnalyticsProtocolMap = {
|
|
91
91
|
[k in AnalyticsOnlyCalls]: VoidCall;
|
|
@@ -1786,6 +1786,7 @@ declare type BaseConfig = {
|
|
|
1786
1786
|
devToolsPort?: number;
|
|
1787
1787
|
installerUI?: boolean;
|
|
1788
1788
|
runtime?: RuntimeConfig;
|
|
1789
|
+
apiDiagnostics?: boolean;
|
|
1789
1790
|
appAssets?: [
|
|
1790
1791
|
{
|
|
1791
1792
|
src: string;
|
|
@@ -7079,6 +7080,16 @@ declare type IntentMetadata<TargetType = any> = {
|
|
|
7079
7080
|
*/
|
|
7080
7081
|
declare class InterApplicationBus extends Base {
|
|
7081
7082
|
Channel: Channel;
|
|
7083
|
+
/**
|
|
7084
|
+
* Event types for the InterApplicationBus.
|
|
7085
|
+
*
|
|
7086
|
+
* @remarks The `subscriber-added` and `subscriber-removed` events are disabled by default.
|
|
7087
|
+
* To re-enable them, launch the runtime with the `--emit-legacy-iab-events` flag.
|
|
7088
|
+
* These events will be removed in a future version. Use {@link Channel} for connection
|
|
7089
|
+
* lifecycle management instead.
|
|
7090
|
+
*
|
|
7091
|
+
* @deprecated Use {@link Channel} `onConnection` / `onDisconnection` instead.
|
|
7092
|
+
*/
|
|
7082
7093
|
events: {
|
|
7083
7094
|
subscriberAdded: string;
|
|
7084
7095
|
subscriberRemoved: string;
|
|
@@ -10993,6 +11004,9 @@ declare namespace OpenFin {
|
|
|
10993
11004
|
SystemProcessInfo,
|
|
10994
11005
|
ClearCacheOption,
|
|
10995
11006
|
ClearDataOptions,
|
|
11007
|
+
TraceConfig,
|
|
11008
|
+
TraceCategoriesAndOptions,
|
|
11009
|
+
TraceBufferUsage,
|
|
10996
11010
|
CookieInfo,
|
|
10997
11011
|
CookieOption,
|
|
10998
11012
|
CrashReporterOptions,
|
|
@@ -13666,19 +13680,17 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
13666
13680
|
response: OpenFin.MenuResult;
|
|
13667
13681
|
};
|
|
13668
13682
|
'close-tray-icon-popup-menu': IdentityCall<{}, void>;
|
|
13669
|
-
'wrap-application': VoidCall;
|
|
13670
|
-
'wrap-application-sync': VoidCall;
|
|
13671
13683
|
'create-application': ApiCall<OpenFin.ApplicationCreationOptions, void>;
|
|
13672
|
-
'application-create': VoidCall;
|
|
13673
|
-
'start-application': VoidCall;
|
|
13674
13684
|
'run-applications': ApiCall<{
|
|
13675
13685
|
applications: Array<OpenFin.ManifestInfo>;
|
|
13676
13686
|
opts?: OpenFin.RvmLaunchOptions;
|
|
13677
13687
|
}, void>;
|
|
13678
|
-
'
|
|
13679
|
-
|
|
13680
|
-
|
|
13681
|
-
|
|
13688
|
+
'send-analytics-batch': {
|
|
13689
|
+
request: {
|
|
13690
|
+
counts: Record<string, number>;
|
|
13691
|
+
};
|
|
13692
|
+
response: void;
|
|
13693
|
+
};
|
|
13682
13694
|
'request-external-authorization': {
|
|
13683
13695
|
request: any;
|
|
13684
13696
|
response: void;
|
|
@@ -13797,10 +13809,6 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
13797
13809
|
options: OpenFin.UpdatableViewOptions;
|
|
13798
13810
|
}>;
|
|
13799
13811
|
'trigger-before-unload': IdentityCall<{}, boolean>;
|
|
13800
|
-
'view-wrap-sync': VoidCall;
|
|
13801
|
-
'view-wrap': VoidCall;
|
|
13802
|
-
'view-get-current': VoidCall;
|
|
13803
|
-
'view-get-current-sync': VoidCall;
|
|
13804
13812
|
'animate-window': IdentityCall<{
|
|
13805
13813
|
transitions: OpenFin.Transition;
|
|
13806
13814
|
options: OpenFin.TransitionOptions;
|
|
@@ -13892,11 +13900,6 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
13892
13900
|
};
|
|
13893
13901
|
response: void;
|
|
13894
13902
|
};
|
|
13895
|
-
'window-wrap': VoidCall;
|
|
13896
|
-
'window-wrap-sync': VoidCall;
|
|
13897
|
-
'create-window': VoidCall;
|
|
13898
|
-
'get-current-window': VoidCall;
|
|
13899
|
-
'get-current-window-sync': VoidCall;
|
|
13900
13903
|
'show-download-bubble': IdentityCall<{
|
|
13901
13904
|
anchor?: OpenFin.Anchor;
|
|
13902
13905
|
}, void>;
|
|
@@ -13904,14 +13907,8 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
13904
13907
|
anchor: OpenFin.Anchor;
|
|
13905
13908
|
}, void>;
|
|
13906
13909
|
'get-external-application-info': ApiCall<OpenFin.ApplicationIdentity, OpenFin.ExternalApplicationInfo>;
|
|
13907
|
-
'external-application-wrap': VoidCall;
|
|
13908
|
-
'external-application-wrap-sync': VoidCall;
|
|
13909
13910
|
'get-frame-info': ApiCall<OpenFin.Identity, OpenFin.FrameInfo>;
|
|
13910
13911
|
'get-parent-window': ApiCall<OpenFin.Identity, OpenFin.FrameInfo>;
|
|
13911
|
-
'frame-wrap': VoidCall;
|
|
13912
|
-
'frame-wrap-sync': VoidCall;
|
|
13913
|
-
'frame-get-current': VoidCall;
|
|
13914
|
-
'frame-get-current-sync': VoidCall;
|
|
13915
13912
|
'global-hotkey-register': {
|
|
13916
13913
|
request: {
|
|
13917
13914
|
hotkey: string;
|
|
@@ -14004,6 +14001,12 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
14004
14001
|
}, OpenFin.NativeTheme>;
|
|
14005
14002
|
'get-theme-preferences': GetterCall<OpenFin.NativeTheme>;
|
|
14006
14003
|
'get-version': GetterCall<string>;
|
|
14004
|
+
'content-tracing-get-categories': GetterCall<string[]>;
|
|
14005
|
+
'content-tracing-start-recording': ApiCall<{
|
|
14006
|
+
options: OpenFin.TraceConfig | OpenFin.TraceCategoriesAndOptions;
|
|
14007
|
+
}, void>;
|
|
14008
|
+
'content-tracing-stop-recording': GetterCall<string>;
|
|
14009
|
+
'content-tracing-get-trace-buffer-usage': GetterCall<OpenFin.TraceBufferUsage>;
|
|
14007
14010
|
'clear-cache': ApiCall<OpenFin.ClearCacheOption, void>;
|
|
14008
14011
|
'clear-http-cache': VoidCall;
|
|
14009
14012
|
'clear-cache-data': ApiCall<OpenFin.ClearDataOptions, void>;
|
|
@@ -14248,7 +14251,6 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
14248
14251
|
apiPath: '.resolveDomainSettings';
|
|
14249
14252
|
namespace: 'System';
|
|
14250
14253
|
};
|
|
14251
|
-
'system-register-shutdown-handler': VoidCall;
|
|
14252
14254
|
'get-permissions': GetterCall<any>;
|
|
14253
14255
|
'refresh-extensions': {
|
|
14254
14256
|
request: void;
|
|
@@ -14267,24 +14269,6 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
14267
14269
|
request: void;
|
|
14268
14270
|
response: Array<OpenFin.ThemePalette>;
|
|
14269
14271
|
};
|
|
14270
|
-
'fdc3-add-context-listener': VoidCall;
|
|
14271
|
-
'fdc3-add-intent-listener': VoidCall;
|
|
14272
|
-
'fdc3-raise-intent': VoidCall;
|
|
14273
|
-
'fdc3-find-intent': VoidCall;
|
|
14274
|
-
'fdc3-find-intents-by-context': VoidCall;
|
|
14275
|
-
'fdc3-raise-intent-for-context': VoidCall;
|
|
14276
|
-
'fdc3-get-info': VoidCall;
|
|
14277
|
-
'fdc3-find-instances': VoidCall;
|
|
14278
|
-
'fdc3-get-app-metadata': VoidCall;
|
|
14279
|
-
'fdc3-broadcast': VoidCall;
|
|
14280
|
-
'fdc3-open': VoidCall;
|
|
14281
|
-
'fdc3-get-or-create-channel': VoidCall;
|
|
14282
|
-
'fdc3-get-system-channels': VoidCall;
|
|
14283
|
-
'fdc3-join-channel': VoidCall;
|
|
14284
|
-
'fdc3-get-current-channel': VoidCall;
|
|
14285
|
-
'fdc3-leave-current-channel': VoidCall;
|
|
14286
|
-
'interop-init': VoidCall;
|
|
14287
|
-
'interop-connect-sync': VoidCall;
|
|
14288
14272
|
'interop-client-set-context': VoidCall;
|
|
14289
14273
|
'interop-client-add-context-handler': VoidCall;
|
|
14290
14274
|
'interop-client-get-context-groups': VoidCall;
|
|
@@ -14315,12 +14299,6 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
14315
14299
|
'interop-session-context-group-set-context': VoidCall;
|
|
14316
14300
|
'interop-session-context-group-get-context': VoidCall;
|
|
14317
14301
|
'interop-session-context-group-add-handler': VoidCall;
|
|
14318
|
-
'platform-wrap': VoidCall;
|
|
14319
|
-
'platform-wrap-sync': VoidCall;
|
|
14320
|
-
'platform-get-current': VoidCall;
|
|
14321
|
-
'platform-get-current-sync': VoidCall;
|
|
14322
|
-
'platform-start': VoidCall;
|
|
14323
|
-
'platform-start-from-manifest': VoidCall;
|
|
14324
14302
|
'platform-get-client': ApplicationIdentityCall<{}, void>;
|
|
14325
14303
|
'platform-create-view': ApplicationIdentityCall<{}, void>;
|
|
14326
14304
|
'platform-create-window': ApplicationIdentityCall<{}, void>;
|
|
@@ -14333,11 +14311,6 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
14333
14311
|
'platform-set-window-context': ApplicationIdentityCall<{}, void>;
|
|
14334
14312
|
'platform-get-window-context': ApplicationIdentityCall<{}, void>;
|
|
14335
14313
|
'platform-close-window': ApplicationIdentityCall<{}, void>;
|
|
14336
|
-
'layout-wrap': VoidCall;
|
|
14337
|
-
'layout-wrap-sync': VoidCall;
|
|
14338
|
-
'layout-get-current': VoidCall;
|
|
14339
|
-
'layout-get-current-sync': VoidCall;
|
|
14340
|
-
'layout-init': VoidCall;
|
|
14341
14314
|
'layout-get-config': VoidCall;
|
|
14342
14315
|
'layout-get-views': VoidCall;
|
|
14343
14316
|
'layout-replace': VoidCall;
|
|
@@ -14356,12 +14329,6 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
14356
14329
|
'layout-controller-create-adjacent-stack': VoidCall;
|
|
14357
14330
|
'layout-controller-get-adjacent-stacks': VoidCall;
|
|
14358
14331
|
'layout-controller-set-stack-active-view': VoidCall;
|
|
14359
|
-
'snapshot-source-init': VoidCall;
|
|
14360
|
-
'snapshot-source-wrap-sync': VoidCall;
|
|
14361
|
-
'snapshot-source-wrap': VoidCall;
|
|
14362
|
-
'snapshot-source-ready': VoidCall;
|
|
14363
|
-
'snapshot-source-get-snapshot': VoidCall;
|
|
14364
|
-
'snapshot-source-apply-snapshot': VoidCall;
|
|
14365
14332
|
'capture-page': IdentityCall<{
|
|
14366
14333
|
options?: OpenFin.CapturePageOptions;
|
|
14367
14334
|
}, string>;
|
|
@@ -15596,6 +15563,10 @@ declare type SubscriptionOptions = {
|
|
|
15596
15563
|
*
|
|
15597
15564
|
*/
|
|
15598
15565
|
declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
15566
|
+
/**
|
|
15567
|
+
* Chromium content tracing APIs.
|
|
15568
|
+
*/
|
|
15569
|
+
readonly ContentTracing: SystemContentTracing;
|
|
15599
15570
|
/**
|
|
15600
15571
|
* @internal
|
|
15601
15572
|
*/
|
|
@@ -17232,6 +17203,36 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
17232
17203
|
getThemePalette(): Promise<Array<OpenFin.ThemePalette>>;
|
|
17233
17204
|
}
|
|
17234
17205
|
|
|
17206
|
+
/**
|
|
17207
|
+
* Chromium content tracing APIs exposed under `fin.System.ContentTracing`.
|
|
17208
|
+
*/
|
|
17209
|
+
declare class SystemContentTracing extends Base {
|
|
17210
|
+
/**
|
|
17211
|
+
* Gets the currently known tracing category groups.
|
|
17212
|
+
*/
|
|
17213
|
+
getCategories(): Promise<string[]>;
|
|
17214
|
+
/**
|
|
17215
|
+
* Starts content tracing across runtime processes.
|
|
17216
|
+
*
|
|
17217
|
+
* Only one content tracing session may be active across the runtime at a time.
|
|
17218
|
+
* This method rejects if another identity already owns the active session.
|
|
17219
|
+
*/
|
|
17220
|
+
startRecording(options: OpenFin.TraceConfig | OpenFin.TraceCategoriesAndOptions): Promise<void>;
|
|
17221
|
+
/**
|
|
17222
|
+
* Stops the active content tracing session and writes the trace to the runtime-managed cache folder.
|
|
17223
|
+
*
|
|
17224
|
+
* The calling identity must match the identity that started the active tracing session.
|
|
17225
|
+
* This method rejects if tracing is not active or is owned by another identity.
|
|
17226
|
+
*/
|
|
17227
|
+
stopRecording(): Promise<string>;
|
|
17228
|
+
/**
|
|
17229
|
+
* Returns the current maximum trace buffer usage across processes.
|
|
17230
|
+
*
|
|
17231
|
+
* This method is not supported on macOS and rejects on that platform.
|
|
17232
|
+
*/
|
|
17233
|
+
getTraceBufferUsage(): Promise<OpenFin.TraceBufferUsage>;
|
|
17234
|
+
}
|
|
17235
|
+
|
|
17235
17236
|
/**
|
|
17236
17237
|
* @deprecated Renamed to {@link Event}.
|
|
17237
17238
|
*/
|
|
@@ -17678,6 +17679,76 @@ declare type Time = {
|
|
|
17678
17679
|
|
|
17679
17680
|
declare type TimeZones = 'utc' | 'local';
|
|
17680
17681
|
|
|
17682
|
+
/**
|
|
17683
|
+
* @interface
|
|
17684
|
+
* Current maximum usage across trace buffers.
|
|
17685
|
+
*/
|
|
17686
|
+
declare type TraceBufferUsage = {
|
|
17687
|
+
value: number;
|
|
17688
|
+
percentage: number;
|
|
17689
|
+
};
|
|
17690
|
+
|
|
17691
|
+
/**
|
|
17692
|
+
* @interface
|
|
17693
|
+
* Shorthand tracing configuration based on Electron's contentTracing.startRecording() API.
|
|
17694
|
+
*/
|
|
17695
|
+
declare type TraceCategoriesAndOptions = {
|
|
17696
|
+
/**
|
|
17697
|
+
* Filter that controls which category groups should be traced.
|
|
17698
|
+
* A filter can have an optional '-' prefix to exclude category groups that contain a matching category. Having both included and excluded category patterns in the same list is not supported. Examples: test_MyTest*, test_MyTest*,test_OtherStuff, -excluded_category1,-excluded_category2.
|
|
17699
|
+
*/
|
|
17700
|
+
categoryFilter: string;
|
|
17701
|
+
/**
|
|
17702
|
+
* Comma-delimited string controlling recording mode and extra trace options. valid strings; record-until-full, record-continuously, trace-to-console, enable-sampling, enable-systrace, e.g. 'record-until-full,enable-sampling'. The first 3 options are trace recording modes and hence mutually exclusive. If more than one trace recording modes appear in the traceOptions string, the last one takes precedence. If none of the trace recording modes are specified, recording mode is record-until-full. The trace option will first be reset to the default option (record_mode set to record-until-full, enable_sampling and enable_systrace set to false) before options parsed from traceOptions are applied on it.
|
|
17703
|
+
*/
|
|
17704
|
+
traceOptions: string;
|
|
17705
|
+
};
|
|
17706
|
+
|
|
17707
|
+
/**
|
|
17708
|
+
* @interface
|
|
17709
|
+
* Structured tracing configuration based on Electron's contentTracing.startRecording() API.
|
|
17710
|
+
*/
|
|
17711
|
+
declare type TraceConfig = {
|
|
17712
|
+
/**
|
|
17713
|
+
* Can be `record-until-full`, `record-continuously`, `record-as-much-as-possible` or `trace-to-console`.
|
|
17714
|
+
* Defaults to `record-until-full`, which will record until the trace buffer is full and then stop recording.
|
|
17715
|
+
*/
|
|
17716
|
+
recording_mode?: 'record-until-full' | 'record-continuously' | 'record-as-much-as-possible' | 'trace-to-console';
|
|
17717
|
+
/**
|
|
17718
|
+
* Maximum size of the trace recording buffer in kilobytes.
|
|
17719
|
+
*/
|
|
17720
|
+
trace_buffer_size_in_kb?: number;
|
|
17721
|
+
/**
|
|
17722
|
+
* Maximum size of the trace recording buffer in events.
|
|
17723
|
+
* Defaults to 100MB
|
|
17724
|
+
*/
|
|
17725
|
+
trace_buffer_size_in_events?: number;
|
|
17726
|
+
/**
|
|
17727
|
+
* Filters event data according to Chromium's vetted allowlist.
|
|
17728
|
+
*/
|
|
17729
|
+
enable_argument_filter?: boolean;
|
|
17730
|
+
/**
|
|
17731
|
+
* A list of tracing categories to include.
|
|
17732
|
+
*/
|
|
17733
|
+
included_categories?: string[];
|
|
17734
|
+
/**
|
|
17735
|
+
* A list of tracing categories to exclude.
|
|
17736
|
+
*/
|
|
17737
|
+
excluded_categories?: string[];
|
|
17738
|
+
/**
|
|
17739
|
+
* A list of process IDs to include in the trace.
|
|
17740
|
+
*/
|
|
17741
|
+
included_process_ids?: number[];
|
|
17742
|
+
/**
|
|
17743
|
+
* A list of histogram names to report with the trace.
|
|
17744
|
+
*/
|
|
17745
|
+
histogram_names?: string[];
|
|
17746
|
+
/**
|
|
17747
|
+
* Additional configuration for memory tracing when memory-infra tracing is enabled.
|
|
17748
|
+
*/
|
|
17749
|
+
memory_dump_config?: Record<string, any>;
|
|
17750
|
+
};
|
|
17751
|
+
|
|
17681
17752
|
/**
|
|
17682
17753
|
* @interface
|
|
17683
17754
|
*/
|
|
@@ -17746,9 +17817,12 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
|
|
|
17746
17817
|
sendRaw: Wire['send'];
|
|
17747
17818
|
eventAggregator: EventAggregator;
|
|
17748
17819
|
protected messageHandlers: MessageHandler[];
|
|
17749
|
-
constructor(factory: WireFactory, environment: Environment, config: OpenFin.Identity
|
|
17820
|
+
constructor(factory: WireFactory, environment: Environment, config: OpenFin.Identity & {
|
|
17821
|
+
apiDiagnostics?: boolean;
|
|
17822
|
+
});
|
|
17750
17823
|
getFin(): OpenFin.Fin<MeType>;
|
|
17751
17824
|
registerFin(_fin: OpenFin.Fin<MeType>): void;
|
|
17825
|
+
recordAnalytic(action: string): void;
|
|
17752
17826
|
connectSync: () => void;
|
|
17753
17827
|
getPort: () => string;
|
|
17754
17828
|
shutdown(): Promise<void>;
|