@openfin/fdc3-api 45.100.93 → 45.100.95
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 +34 -25
- package/out/fdc3-api-beta.d.ts +34 -25
- package/out/fdc3-api-public.d.ts +34 -25
- package/out/fdc3-api.d.ts +34 -25
- package/package.json +1 -1
package/out/fdc3-api-alpha.d.ts
CHANGED
|
@@ -14077,6 +14077,9 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
14077
14077
|
namespace: 'System';
|
|
14078
14078
|
};
|
|
14079
14079
|
'register-usage': ApiCall<OpenFin.RegisterUsageData, void>;
|
|
14080
|
+
'register-usage-batch': ApiCall<{
|
|
14081
|
+
items: OpenFin.RegisterUsageData[];
|
|
14082
|
+
}, void>;
|
|
14080
14083
|
'system-get-printers': GetterCall<OpenFin.PrinterInfo[]>;
|
|
14081
14084
|
'system-update-process-logging-options': ApiCall<{
|
|
14082
14085
|
options: OpenFin.ProcessLoggingOptions;
|
|
@@ -15439,13 +15442,8 @@ declare type SubscriptionOptions = {
|
|
|
15439
15442
|
timestamp?: number;
|
|
15440
15443
|
};
|
|
15441
15444
|
|
|
15442
|
-
/**
|
|
15443
|
-
* An object representing the core of OpenFin Runtime. Allows the developer
|
|
15444
|
-
* to perform system-level actions, such as accessing logs, viewing processes,
|
|
15445
|
-
* clearing the cache and exiting the runtime as well as listen to {@link OpenFin.SystemEvents system events}.
|
|
15446
|
-
*
|
|
15447
|
-
*/
|
|
15448
15445
|
declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
15446
|
+
#private;
|
|
15449
15447
|
/**
|
|
15450
15448
|
* Chromium content tracing APIs.
|
|
15451
15449
|
*/
|
|
@@ -16793,30 +16791,41 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
16793
16791
|
queryPermissionForCurrentContext(apiName: string): Promise<OpenFin.QueryPermissionResult>;
|
|
16794
16792
|
enableNativeWindowIntegrationProvider(permissions: any): Promise<OpenFin.NativeWindowIntegrationProviderAuthorization>;
|
|
16795
16793
|
/**
|
|
16796
|
-
* (Internal) Register the usage of a component with a platform
|
|
16797
|
-
*
|
|
16794
|
+
* (Internal) Register the usage of a component with a platform.
|
|
16795
|
+
*
|
|
16796
|
+
* @param options - Object with `data` and `type`.
|
|
16797
|
+
*
|
|
16798
|
+
* @remarks
|
|
16799
|
+
* **This method never throws.** All errors — including IPC failures, RVM timeouts, and
|
|
16800
|
+
* serialization errors — are caught internally and logged at `debug` level. Usage tracking
|
|
16801
|
+
* must never break the calling feature.
|
|
16802
|
+
*
|
|
16803
|
+
* Calls are automatically deduplicated client-side for the lifetime of the current window
|
|
16804
|
+
* (i.e. until the window is closed or the page is reloaded). The first call with a given
|
|
16805
|
+
* `type` + `data` combination is forwarded to the Runtime as normal. Any subsequent call
|
|
16806
|
+
* with the same `type` and `data` values within the same window lifetime is silently
|
|
16807
|
+
* suppressed without making an IPC round-trip.
|
|
16808
|
+
*
|
|
16809
|
+
* If `data` cannot be serialized to JSON (for example, a circular reference), deduplication
|
|
16810
|
+
* is skipped for that call and the IPC call is still forwarded unconditionally.
|
|
16798
16811
|
*
|
|
16799
16812
|
* @example
|
|
16800
16813
|
* ```js
|
|
16801
|
-
*
|
|
16802
|
-
*
|
|
16803
|
-
*
|
|
16804
|
-
*
|
|
16805
|
-
*
|
|
16806
|
-
*
|
|
16807
|
-
*
|
|
16808
|
-
*
|
|
16809
|
-
*
|
|
16810
|
-
*
|
|
16811
|
-
*
|
|
16812
|
-
*
|
|
16813
|
-
* });
|
|
16814
|
-
* }
|
|
16815
|
-
*
|
|
16816
|
-
* registerUsage().then(() => console.log('Successfully registered component application')).catch(err => console.log(err));
|
|
16814
|
+
* // Safe to fire-and-forget — will never throw or reject.
|
|
16815
|
+
* // Duplicate calls within the same window lifetime are suppressed automatically.
|
|
16816
|
+
* fin.System.registerUsage({
|
|
16817
|
+
* type: 'workspace-licensing',
|
|
16818
|
+
* data: {
|
|
16819
|
+
* apiVersion: '1.0',
|
|
16820
|
+
* componentName: 'home',
|
|
16821
|
+
* componentVersion: '1.0',
|
|
16822
|
+
* allowed: true,
|
|
16823
|
+
* rejectionCode: ''
|
|
16824
|
+
* }
|
|
16825
|
+
* });
|
|
16817
16826
|
* ```
|
|
16818
16827
|
*/
|
|
16819
|
-
registerUsage({ data, type }: OpenFin.RegisterUsageData):
|
|
16828
|
+
registerUsage({ data, type }: OpenFin.RegisterUsageData): void;
|
|
16820
16829
|
/**
|
|
16821
16830
|
* Returns an array with all printers of the caller and not all the printers on the desktop.
|
|
16822
16831
|
*
|
package/out/fdc3-api-beta.d.ts
CHANGED
|
@@ -14077,6 +14077,9 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
14077
14077
|
namespace: 'System';
|
|
14078
14078
|
};
|
|
14079
14079
|
'register-usage': ApiCall<OpenFin.RegisterUsageData, void>;
|
|
14080
|
+
'register-usage-batch': ApiCall<{
|
|
14081
|
+
items: OpenFin.RegisterUsageData[];
|
|
14082
|
+
}, void>;
|
|
14080
14083
|
'system-get-printers': GetterCall<OpenFin.PrinterInfo[]>;
|
|
14081
14084
|
'system-update-process-logging-options': ApiCall<{
|
|
14082
14085
|
options: OpenFin.ProcessLoggingOptions;
|
|
@@ -15439,13 +15442,8 @@ declare type SubscriptionOptions = {
|
|
|
15439
15442
|
timestamp?: number;
|
|
15440
15443
|
};
|
|
15441
15444
|
|
|
15442
|
-
/**
|
|
15443
|
-
* An object representing the core of OpenFin Runtime. Allows the developer
|
|
15444
|
-
* to perform system-level actions, such as accessing logs, viewing processes,
|
|
15445
|
-
* clearing the cache and exiting the runtime as well as listen to {@link OpenFin.SystemEvents system events}.
|
|
15446
|
-
*
|
|
15447
|
-
*/
|
|
15448
15445
|
declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
15446
|
+
#private;
|
|
15449
15447
|
/**
|
|
15450
15448
|
* Chromium content tracing APIs.
|
|
15451
15449
|
*/
|
|
@@ -16793,30 +16791,41 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
16793
16791
|
queryPermissionForCurrentContext(apiName: string): Promise<OpenFin.QueryPermissionResult>;
|
|
16794
16792
|
enableNativeWindowIntegrationProvider(permissions: any): Promise<OpenFin.NativeWindowIntegrationProviderAuthorization>;
|
|
16795
16793
|
/**
|
|
16796
|
-
* (Internal) Register the usage of a component with a platform
|
|
16797
|
-
*
|
|
16794
|
+
* (Internal) Register the usage of a component with a platform.
|
|
16795
|
+
*
|
|
16796
|
+
* @param options - Object with `data` and `type`.
|
|
16797
|
+
*
|
|
16798
|
+
* @remarks
|
|
16799
|
+
* **This method never throws.** All errors — including IPC failures, RVM timeouts, and
|
|
16800
|
+
* serialization errors — are caught internally and logged at `debug` level. Usage tracking
|
|
16801
|
+
* must never break the calling feature.
|
|
16802
|
+
*
|
|
16803
|
+
* Calls are automatically deduplicated client-side for the lifetime of the current window
|
|
16804
|
+
* (i.e. until the window is closed or the page is reloaded). The first call with a given
|
|
16805
|
+
* `type` + `data` combination is forwarded to the Runtime as normal. Any subsequent call
|
|
16806
|
+
* with the same `type` and `data` values within the same window lifetime is silently
|
|
16807
|
+
* suppressed without making an IPC round-trip.
|
|
16808
|
+
*
|
|
16809
|
+
* If `data` cannot be serialized to JSON (for example, a circular reference), deduplication
|
|
16810
|
+
* is skipped for that call and the IPC call is still forwarded unconditionally.
|
|
16798
16811
|
*
|
|
16799
16812
|
* @example
|
|
16800
16813
|
* ```js
|
|
16801
|
-
*
|
|
16802
|
-
*
|
|
16803
|
-
*
|
|
16804
|
-
*
|
|
16805
|
-
*
|
|
16806
|
-
*
|
|
16807
|
-
*
|
|
16808
|
-
*
|
|
16809
|
-
*
|
|
16810
|
-
*
|
|
16811
|
-
*
|
|
16812
|
-
*
|
|
16813
|
-
* });
|
|
16814
|
-
* }
|
|
16815
|
-
*
|
|
16816
|
-
* registerUsage().then(() => console.log('Successfully registered component application')).catch(err => console.log(err));
|
|
16814
|
+
* // Safe to fire-and-forget — will never throw or reject.
|
|
16815
|
+
* // Duplicate calls within the same window lifetime are suppressed automatically.
|
|
16816
|
+
* fin.System.registerUsage({
|
|
16817
|
+
* type: 'workspace-licensing',
|
|
16818
|
+
* data: {
|
|
16819
|
+
* apiVersion: '1.0',
|
|
16820
|
+
* componentName: 'home',
|
|
16821
|
+
* componentVersion: '1.0',
|
|
16822
|
+
* allowed: true,
|
|
16823
|
+
* rejectionCode: ''
|
|
16824
|
+
* }
|
|
16825
|
+
* });
|
|
16817
16826
|
* ```
|
|
16818
16827
|
*/
|
|
16819
|
-
registerUsage({ data, type }: OpenFin.RegisterUsageData):
|
|
16828
|
+
registerUsage({ data, type }: OpenFin.RegisterUsageData): void;
|
|
16820
16829
|
/**
|
|
16821
16830
|
* Returns an array with all printers of the caller and not all the printers on the desktop.
|
|
16822
16831
|
*
|
package/out/fdc3-api-public.d.ts
CHANGED
|
@@ -14077,6 +14077,9 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
14077
14077
|
namespace: 'System';
|
|
14078
14078
|
};
|
|
14079
14079
|
'register-usage': ApiCall<OpenFin.RegisterUsageData, void>;
|
|
14080
|
+
'register-usage-batch': ApiCall<{
|
|
14081
|
+
items: OpenFin.RegisterUsageData[];
|
|
14082
|
+
}, void>;
|
|
14080
14083
|
'system-get-printers': GetterCall<OpenFin.PrinterInfo[]>;
|
|
14081
14084
|
'system-update-process-logging-options': ApiCall<{
|
|
14082
14085
|
options: OpenFin.ProcessLoggingOptions;
|
|
@@ -15439,13 +15442,8 @@ declare type SubscriptionOptions = {
|
|
|
15439
15442
|
timestamp?: number;
|
|
15440
15443
|
};
|
|
15441
15444
|
|
|
15442
|
-
/**
|
|
15443
|
-
* An object representing the core of OpenFin Runtime. Allows the developer
|
|
15444
|
-
* to perform system-level actions, such as accessing logs, viewing processes,
|
|
15445
|
-
* clearing the cache and exiting the runtime as well as listen to {@link OpenFin.SystemEvents system events}.
|
|
15446
|
-
*
|
|
15447
|
-
*/
|
|
15448
15445
|
declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
15446
|
+
#private;
|
|
15449
15447
|
/**
|
|
15450
15448
|
* Chromium content tracing APIs.
|
|
15451
15449
|
*/
|
|
@@ -16793,30 +16791,41 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
16793
16791
|
queryPermissionForCurrentContext(apiName: string): Promise<OpenFin.QueryPermissionResult>;
|
|
16794
16792
|
enableNativeWindowIntegrationProvider(permissions: any): Promise<OpenFin.NativeWindowIntegrationProviderAuthorization>;
|
|
16795
16793
|
/**
|
|
16796
|
-
* (Internal) Register the usage of a component with a platform
|
|
16797
|
-
*
|
|
16794
|
+
* (Internal) Register the usage of a component with a platform.
|
|
16795
|
+
*
|
|
16796
|
+
* @param options - Object with `data` and `type`.
|
|
16797
|
+
*
|
|
16798
|
+
* @remarks
|
|
16799
|
+
* **This method never throws.** All errors — including IPC failures, RVM timeouts, and
|
|
16800
|
+
* serialization errors — are caught internally and logged at `debug` level. Usage tracking
|
|
16801
|
+
* must never break the calling feature.
|
|
16802
|
+
*
|
|
16803
|
+
* Calls are automatically deduplicated client-side for the lifetime of the current window
|
|
16804
|
+
* (i.e. until the window is closed or the page is reloaded). The first call with a given
|
|
16805
|
+
* `type` + `data` combination is forwarded to the Runtime as normal. Any subsequent call
|
|
16806
|
+
* with the same `type` and `data` values within the same window lifetime is silently
|
|
16807
|
+
* suppressed without making an IPC round-trip.
|
|
16808
|
+
*
|
|
16809
|
+
* If `data` cannot be serialized to JSON (for example, a circular reference), deduplication
|
|
16810
|
+
* is skipped for that call and the IPC call is still forwarded unconditionally.
|
|
16798
16811
|
*
|
|
16799
16812
|
* @example
|
|
16800
16813
|
* ```js
|
|
16801
|
-
*
|
|
16802
|
-
*
|
|
16803
|
-
*
|
|
16804
|
-
*
|
|
16805
|
-
*
|
|
16806
|
-
*
|
|
16807
|
-
*
|
|
16808
|
-
*
|
|
16809
|
-
*
|
|
16810
|
-
*
|
|
16811
|
-
*
|
|
16812
|
-
*
|
|
16813
|
-
* });
|
|
16814
|
-
* }
|
|
16815
|
-
*
|
|
16816
|
-
* registerUsage().then(() => console.log('Successfully registered component application')).catch(err => console.log(err));
|
|
16814
|
+
* // Safe to fire-and-forget — will never throw or reject.
|
|
16815
|
+
* // Duplicate calls within the same window lifetime are suppressed automatically.
|
|
16816
|
+
* fin.System.registerUsage({
|
|
16817
|
+
* type: 'workspace-licensing',
|
|
16818
|
+
* data: {
|
|
16819
|
+
* apiVersion: '1.0',
|
|
16820
|
+
* componentName: 'home',
|
|
16821
|
+
* componentVersion: '1.0',
|
|
16822
|
+
* allowed: true,
|
|
16823
|
+
* rejectionCode: ''
|
|
16824
|
+
* }
|
|
16825
|
+
* });
|
|
16817
16826
|
* ```
|
|
16818
16827
|
*/
|
|
16819
|
-
registerUsage({ data, type }: OpenFin.RegisterUsageData):
|
|
16828
|
+
registerUsage({ data, type }: OpenFin.RegisterUsageData): void;
|
|
16820
16829
|
/**
|
|
16821
16830
|
* Returns an array with all printers of the caller and not all the printers on the desktop.
|
|
16822
16831
|
*
|
package/out/fdc3-api.d.ts
CHANGED
|
@@ -14494,6 +14494,9 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
14494
14494
|
namespace: 'System';
|
|
14495
14495
|
};
|
|
14496
14496
|
'register-usage': ApiCall<OpenFin.RegisterUsageData, void>;
|
|
14497
|
+
'register-usage-batch': ApiCall<{
|
|
14498
|
+
items: OpenFin.RegisterUsageData[];
|
|
14499
|
+
}, void>;
|
|
14497
14500
|
'system-get-printers': GetterCall<OpenFin.PrinterInfo[]>;
|
|
14498
14501
|
'system-update-process-logging-options': ApiCall<{
|
|
14499
14502
|
options: OpenFin.ProcessLoggingOptions;
|
|
@@ -15859,13 +15862,8 @@ declare type SubscriptionOptions = {
|
|
|
15859
15862
|
timestamp?: number;
|
|
15860
15863
|
};
|
|
15861
15864
|
|
|
15862
|
-
/**
|
|
15863
|
-
* An object representing the core of OpenFin Runtime. Allows the developer
|
|
15864
|
-
* to perform system-level actions, such as accessing logs, viewing processes,
|
|
15865
|
-
* clearing the cache and exiting the runtime as well as listen to {@link OpenFin.SystemEvents system events}.
|
|
15866
|
-
*
|
|
15867
|
-
*/
|
|
15868
15865
|
declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
15866
|
+
#private;
|
|
15869
15867
|
/**
|
|
15870
15868
|
* Chromium content tracing APIs.
|
|
15871
15869
|
*/
|
|
@@ -17216,30 +17214,41 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
17216
17214
|
queryPermissionForCurrentContext(apiName: string): Promise<OpenFin.QueryPermissionResult>;
|
|
17217
17215
|
enableNativeWindowIntegrationProvider(permissions: any): Promise<OpenFin.NativeWindowIntegrationProviderAuthorization>;
|
|
17218
17216
|
/**
|
|
17219
|
-
* (Internal) Register the usage of a component with a platform
|
|
17220
|
-
*
|
|
17217
|
+
* (Internal) Register the usage of a component with a platform.
|
|
17218
|
+
*
|
|
17219
|
+
* @param options - Object with `data` and `type`.
|
|
17220
|
+
*
|
|
17221
|
+
* @remarks
|
|
17222
|
+
* **This method never throws.** All errors — including IPC failures, RVM timeouts, and
|
|
17223
|
+
* serialization errors — are caught internally and logged at `debug` level. Usage tracking
|
|
17224
|
+
* must never break the calling feature.
|
|
17225
|
+
*
|
|
17226
|
+
* Calls are automatically deduplicated client-side for the lifetime of the current window
|
|
17227
|
+
* (i.e. until the window is closed or the page is reloaded). The first call with a given
|
|
17228
|
+
* `type` + `data` combination is forwarded to the Runtime as normal. Any subsequent call
|
|
17229
|
+
* with the same `type` and `data` values within the same window lifetime is silently
|
|
17230
|
+
* suppressed without making an IPC round-trip.
|
|
17231
|
+
*
|
|
17232
|
+
* If `data` cannot be serialized to JSON (for example, a circular reference), deduplication
|
|
17233
|
+
* is skipped for that call and the IPC call is still forwarded unconditionally.
|
|
17221
17234
|
*
|
|
17222
17235
|
* @example
|
|
17223
17236
|
* ```js
|
|
17224
|
-
*
|
|
17225
|
-
*
|
|
17226
|
-
*
|
|
17227
|
-
*
|
|
17228
|
-
*
|
|
17229
|
-
*
|
|
17230
|
-
*
|
|
17231
|
-
*
|
|
17232
|
-
*
|
|
17233
|
-
*
|
|
17234
|
-
*
|
|
17235
|
-
*
|
|
17236
|
-
* });
|
|
17237
|
-
* }
|
|
17238
|
-
*
|
|
17239
|
-
* registerUsage().then(() => console.log('Successfully registered component application')).catch(err => console.log(err));
|
|
17237
|
+
* // Safe to fire-and-forget — will never throw or reject.
|
|
17238
|
+
* // Duplicate calls within the same window lifetime are suppressed automatically.
|
|
17239
|
+
* fin.System.registerUsage({
|
|
17240
|
+
* type: 'workspace-licensing',
|
|
17241
|
+
* data: {
|
|
17242
|
+
* apiVersion: '1.0',
|
|
17243
|
+
* componentName: 'home',
|
|
17244
|
+
* componentVersion: '1.0',
|
|
17245
|
+
* allowed: true,
|
|
17246
|
+
* rejectionCode: ''
|
|
17247
|
+
* }
|
|
17248
|
+
* });
|
|
17240
17249
|
* ```
|
|
17241
17250
|
*/
|
|
17242
|
-
registerUsage({ data, type }: OpenFin.RegisterUsageData):
|
|
17251
|
+
registerUsage({ data, type }: OpenFin.RegisterUsageData): void;
|
|
17243
17252
|
/**
|
|
17244
17253
|
* Returns an array with all printers of the caller and not all the printers on the desktop.
|
|
17245
17254
|
*
|