@openfin/fdc3-api 42.100.101 → 42.100.103
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 +101 -13
- package/out/fdc3-api-beta.d.ts +101 -13
- package/out/fdc3-api-public.d.ts +101 -13
- package/out/fdc3-api.d.ts +103 -12
- package/package.json +1 -1
package/out/fdc3-api-alpha.d.ts
CHANGED
|
@@ -9752,6 +9752,12 @@ declare type MutableWindowOptions = {
|
|
|
9752
9752
|
/**
|
|
9753
9753
|
* Shows the window's icon in the taskbar.
|
|
9754
9754
|
*
|
|
9755
|
+
* @remarks
|
|
9756
|
+
* In Windows, setting `showTaskbarIcon` to false will cause the window to display on all virtual desktops.
|
|
9757
|
+
* In order to prevent this while keeping `showTaskbarIcon` false, pass the identity of the parent via the
|
|
9758
|
+
* `modalParentIdentity` (see {@link WindowCreationOptions}). This is useful for popups managed by
|
|
9759
|
+
* {@link Window._Window.showPopupWindow}.
|
|
9760
|
+
*
|
|
9755
9761
|
* @default true
|
|
9756
9762
|
*/
|
|
9757
9763
|
showTaskbarIcon: boolean;
|
|
@@ -9893,15 +9899,96 @@ declare type NotificationEvent = {
|
|
|
9893
9899
|
notificationId: string;
|
|
9894
9900
|
};
|
|
9895
9901
|
|
|
9902
|
+
declare type NotificationHandler = (notification: WebNotificationInfo) => void;
|
|
9903
|
+
|
|
9904
|
+
/**
|
|
9905
|
+
* NotificationManagers allow all {@link https://developer.mozilla.org/en-US/docs/Web/API/Notifications_API | HTML5 notifications} created in the application to be intercepted and dispatched.
|
|
9906
|
+
*
|
|
9907
|
+
* Please note, currently Notifications will only be intercepted if the following conditions are met:
|
|
9908
|
+
* - The source WebContents has the `notification` webAPI permission.
|
|
9909
|
+
* - The source WebContents is not a service worker.
|
|
9910
|
+
*
|
|
9911
|
+
* Service worker and push notifications are currently not supported.
|
|
9912
|
+
*
|
|
9913
|
+
* **See also** - {@link https://developer.mozilla.org/en-US/docs/Web/API/Notifications_API | Notification API (MDN)}
|
|
9914
|
+
*
|
|
9915
|
+
* @experimental This API is subject to change in future releases.
|
|
9916
|
+
*
|
|
9917
|
+
*/
|
|
9896
9918
|
declare class NotificationManagerInstance {
|
|
9897
9919
|
#private;
|
|
9898
|
-
|
|
9899
|
-
|
|
9920
|
+
/* Excluded from this release type: __constructor */
|
|
9921
|
+
/**
|
|
9922
|
+
* Sets the current handler for notifications. The provided function will be invoked whenever a WebContents successfully raises a notification.
|
|
9923
|
+
*
|
|
9924
|
+
* **Note**, only one handler can be used at a time, calling `setNotificationHandler` will replace any existing registered handler.
|
|
9925
|
+
*
|
|
9926
|
+
* @param handler The notification handler callback which will be invoked whenever a notification is created.
|
|
9927
|
+
*
|
|
9928
|
+
* @example
|
|
9929
|
+
*
|
|
9930
|
+
* ```typescript
|
|
9931
|
+
* const notificationManager = await fin.NotificationManager.init();
|
|
9932
|
+
* const handler = (notification) => {
|
|
9933
|
+
* console.log("Received the following notification", info);
|
|
9934
|
+
* }
|
|
9935
|
+
* await notificationManager.setNotificationHandler(handler);
|
|
9936
|
+
* ```
|
|
9937
|
+
*/
|
|
9938
|
+
setNotificationHandler: (handler: OpenFin.NotificationHandler) => Promise<void>;
|
|
9939
|
+
/**
|
|
9940
|
+
* Destroys the current NotificationManagerInstance.
|
|
9941
|
+
*
|
|
9942
|
+
* @example
|
|
9943
|
+
* ```typescript
|
|
9944
|
+
* await notificationManager.destroy();
|
|
9945
|
+
* ```
|
|
9946
|
+
*/
|
|
9900
9947
|
destroy: () => Promise<void>;
|
|
9901
|
-
|
|
9948
|
+
/**
|
|
9949
|
+
* Dispatches a Notification lifecycle event ('close' | 'click' | 'show').
|
|
9950
|
+
*
|
|
9951
|
+
* @param event Identifies the type of event to emit, and which `notificationId` to emit it for.
|
|
9952
|
+
*
|
|
9953
|
+
* @example
|
|
9954
|
+
* ```typescript
|
|
9955
|
+
* notificationManager.setNotificationHandler((notification) => {
|
|
9956
|
+
* await mockNotificationUi.showNotification(notification);
|
|
9957
|
+
* await notificationManager.dispatchNotificationEvent({
|
|
9958
|
+
* notificationId: notification.notificationId,
|
|
9959
|
+
* type: 'show
|
|
9960
|
+
* })
|
|
9961
|
+
* })
|
|
9962
|
+
* ```
|
|
9963
|
+
*
|
|
9964
|
+
* **See Also** - {@link https://developer.mozilla.org/en-US/docs/Web/API/Notification/click_event | Notification Click Event (MDN)}
|
|
9965
|
+
*
|
|
9966
|
+
* **See Also** - {@link https://developer.mozilla.org/en-US/docs/Web/API/Notification/close_event | Notification Close Event (MDN)}
|
|
9967
|
+
*
|
|
9968
|
+
* **See Also** - {@link https://developer.mozilla.org/en-US/docs/Web/API/Notification/show_event | Notification Show Event (MDN)}
|
|
9969
|
+
*/
|
|
9970
|
+
dispatch: (event: OpenFin.NotificationEvent) => Promise<void>;
|
|
9902
9971
|
}
|
|
9903
9972
|
|
|
9904
9973
|
declare class NotificationManagerModule extends Base {
|
|
9974
|
+
/**
|
|
9975
|
+
* Initializes a NotificationManager for the current application, which allows interception of HTML5 web notifications.
|
|
9976
|
+
*
|
|
9977
|
+
* Secured by default, must be called from a WebContents with the NotificationManager.init permission.
|
|
9978
|
+
*
|
|
9979
|
+
* Only one NotificationManager can be active at a time, calls to `init` will fail otherwise.
|
|
9980
|
+
*
|
|
9981
|
+
* If a WebContents with the NotificationManager active reloads or is closed, it will be possible to create a new one.
|
|
9982
|
+
*
|
|
9983
|
+
* @example
|
|
9984
|
+
*
|
|
9985
|
+
* ```js
|
|
9986
|
+
* // From Provider context
|
|
9987
|
+
* const notificationManager = await fin.NotificationManager.init();
|
|
9988
|
+
* // NotificationManager is now active and will intercept all incoming notifications.
|
|
9989
|
+
* ```
|
|
9990
|
+
* @experimental
|
|
9991
|
+
*/
|
|
9905
9992
|
init: () => Promise<NotificationManagerInstance>;
|
|
9906
9993
|
}
|
|
9907
9994
|
|
|
@@ -9909,8 +9996,6 @@ declare type NotificationManagerPermissions = {
|
|
|
9909
9996
|
init: boolean;
|
|
9910
9997
|
};
|
|
9911
9998
|
|
|
9912
|
-
declare type NotificiationHandler = (event: WebNotificationInfo) => void;
|
|
9913
|
-
|
|
9914
9999
|
/* Excluded from this release type: NotRequested */
|
|
9915
10000
|
|
|
9916
10001
|
/**
|
|
@@ -10323,11 +10408,12 @@ declare namespace OpenFin {
|
|
|
10323
10408
|
RoutingInfo,
|
|
10324
10409
|
DownloadShelfOptions,
|
|
10325
10410
|
ViewShowAtOptions,
|
|
10411
|
+
WebNotificationProperties,
|
|
10412
|
+
WebNotificationInfo,
|
|
10326
10413
|
NotificationEvent,
|
|
10414
|
+
NotificationHandler,
|
|
10327
10415
|
NotificationManagerInstance,
|
|
10328
10416
|
NotificationManagerModule,
|
|
10329
|
-
WebNotificationInfo,
|
|
10330
|
-
WebNotificationProperties,
|
|
10331
10417
|
ExtensionInfo,
|
|
10332
10418
|
ServeRequest,
|
|
10333
10419
|
AppAssetServeRequest,
|
|
@@ -13097,6 +13183,13 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
13097
13183
|
apiPath: '.getOSInfo';
|
|
13098
13184
|
namespace: 'System';
|
|
13099
13185
|
};
|
|
13186
|
+
'launch-log-uploader': ApiCall<{
|
|
13187
|
+
options: OpenFin.LogUploaderOptions;
|
|
13188
|
+
}, void> & {
|
|
13189
|
+
secure: true;
|
|
13190
|
+
apiPath: '.launchLogUploader';
|
|
13191
|
+
namespace: 'System';
|
|
13192
|
+
};
|
|
13100
13193
|
'launch-external-process': ApiCall<OpenFin.ExternalProcessRequestType, OpenFin.Identity> & {
|
|
13101
13194
|
secure: true;
|
|
13102
13195
|
apiPath: '.launchExternalProcess';
|
|
@@ -13464,12 +13557,6 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
13464
13557
|
};
|
|
13465
13558
|
response: void;
|
|
13466
13559
|
};
|
|
13467
|
-
'launch-log-uploader': ApiCall<{
|
|
13468
|
-
options: OpenFin.LogUploaderOptions;
|
|
13469
|
-
}, void> & {
|
|
13470
|
-
apiPath: '.launchLogUploader';
|
|
13471
|
-
namespace: 'System';
|
|
13472
|
-
};
|
|
13473
13560
|
'dispatch-notification-event': {
|
|
13474
13561
|
request: {
|
|
13475
13562
|
notificationId: string;
|
|
@@ -16121,6 +16208,7 @@ declare type SystemPermissions = {
|
|
|
16121
16208
|
downloadAsset: boolean;
|
|
16122
16209
|
serveAsset: boolean;
|
|
16123
16210
|
enableNativeWindowIntegrationProvider: boolean;
|
|
16211
|
+
launchLogUploader: boolean;
|
|
16124
16212
|
};
|
|
16125
16213
|
|
|
16126
16214
|
/**
|
package/out/fdc3-api-beta.d.ts
CHANGED
|
@@ -9752,6 +9752,12 @@ declare type MutableWindowOptions = {
|
|
|
9752
9752
|
/**
|
|
9753
9753
|
* Shows the window's icon in the taskbar.
|
|
9754
9754
|
*
|
|
9755
|
+
* @remarks
|
|
9756
|
+
* In Windows, setting `showTaskbarIcon` to false will cause the window to display on all virtual desktops.
|
|
9757
|
+
* In order to prevent this while keeping `showTaskbarIcon` false, pass the identity of the parent via the
|
|
9758
|
+
* `modalParentIdentity` (see {@link WindowCreationOptions}). This is useful for popups managed by
|
|
9759
|
+
* {@link Window._Window.showPopupWindow}.
|
|
9760
|
+
*
|
|
9755
9761
|
* @default true
|
|
9756
9762
|
*/
|
|
9757
9763
|
showTaskbarIcon: boolean;
|
|
@@ -9893,15 +9899,96 @@ declare type NotificationEvent = {
|
|
|
9893
9899
|
notificationId: string;
|
|
9894
9900
|
};
|
|
9895
9901
|
|
|
9902
|
+
declare type NotificationHandler = (notification: WebNotificationInfo) => void;
|
|
9903
|
+
|
|
9904
|
+
/**
|
|
9905
|
+
* NotificationManagers allow all {@link https://developer.mozilla.org/en-US/docs/Web/API/Notifications_API | HTML5 notifications} created in the application to be intercepted and dispatched.
|
|
9906
|
+
*
|
|
9907
|
+
* Please note, currently Notifications will only be intercepted if the following conditions are met:
|
|
9908
|
+
* - The source WebContents has the `notification` webAPI permission.
|
|
9909
|
+
* - The source WebContents is not a service worker.
|
|
9910
|
+
*
|
|
9911
|
+
* Service worker and push notifications are currently not supported.
|
|
9912
|
+
*
|
|
9913
|
+
* **See also** - {@link https://developer.mozilla.org/en-US/docs/Web/API/Notifications_API | Notification API (MDN)}
|
|
9914
|
+
*
|
|
9915
|
+
* @experimental This API is subject to change in future releases.
|
|
9916
|
+
*
|
|
9917
|
+
*/
|
|
9896
9918
|
declare class NotificationManagerInstance {
|
|
9897
9919
|
#private;
|
|
9898
|
-
|
|
9899
|
-
|
|
9920
|
+
/* Excluded from this release type: __constructor */
|
|
9921
|
+
/**
|
|
9922
|
+
* Sets the current handler for notifications. The provided function will be invoked whenever a WebContents successfully raises a notification.
|
|
9923
|
+
*
|
|
9924
|
+
* **Note**, only one handler can be used at a time, calling `setNotificationHandler` will replace any existing registered handler.
|
|
9925
|
+
*
|
|
9926
|
+
* @param handler The notification handler callback which will be invoked whenever a notification is created.
|
|
9927
|
+
*
|
|
9928
|
+
* @example
|
|
9929
|
+
*
|
|
9930
|
+
* ```typescript
|
|
9931
|
+
* const notificationManager = await fin.NotificationManager.init();
|
|
9932
|
+
* const handler = (notification) => {
|
|
9933
|
+
* console.log("Received the following notification", info);
|
|
9934
|
+
* }
|
|
9935
|
+
* await notificationManager.setNotificationHandler(handler);
|
|
9936
|
+
* ```
|
|
9937
|
+
*/
|
|
9938
|
+
setNotificationHandler: (handler: OpenFin.NotificationHandler) => Promise<void>;
|
|
9939
|
+
/**
|
|
9940
|
+
* Destroys the current NotificationManagerInstance.
|
|
9941
|
+
*
|
|
9942
|
+
* @example
|
|
9943
|
+
* ```typescript
|
|
9944
|
+
* await notificationManager.destroy();
|
|
9945
|
+
* ```
|
|
9946
|
+
*/
|
|
9900
9947
|
destroy: () => Promise<void>;
|
|
9901
|
-
|
|
9948
|
+
/**
|
|
9949
|
+
* Dispatches a Notification lifecycle event ('close' | 'click' | 'show').
|
|
9950
|
+
*
|
|
9951
|
+
* @param event Identifies the type of event to emit, and which `notificationId` to emit it for.
|
|
9952
|
+
*
|
|
9953
|
+
* @example
|
|
9954
|
+
* ```typescript
|
|
9955
|
+
* notificationManager.setNotificationHandler((notification) => {
|
|
9956
|
+
* await mockNotificationUi.showNotification(notification);
|
|
9957
|
+
* await notificationManager.dispatchNotificationEvent({
|
|
9958
|
+
* notificationId: notification.notificationId,
|
|
9959
|
+
* type: 'show
|
|
9960
|
+
* })
|
|
9961
|
+
* })
|
|
9962
|
+
* ```
|
|
9963
|
+
*
|
|
9964
|
+
* **See Also** - {@link https://developer.mozilla.org/en-US/docs/Web/API/Notification/click_event | Notification Click Event (MDN)}
|
|
9965
|
+
*
|
|
9966
|
+
* **See Also** - {@link https://developer.mozilla.org/en-US/docs/Web/API/Notification/close_event | Notification Close Event (MDN)}
|
|
9967
|
+
*
|
|
9968
|
+
* **See Also** - {@link https://developer.mozilla.org/en-US/docs/Web/API/Notification/show_event | Notification Show Event (MDN)}
|
|
9969
|
+
*/
|
|
9970
|
+
dispatch: (event: OpenFin.NotificationEvent) => Promise<void>;
|
|
9902
9971
|
}
|
|
9903
9972
|
|
|
9904
9973
|
declare class NotificationManagerModule extends Base {
|
|
9974
|
+
/**
|
|
9975
|
+
* Initializes a NotificationManager for the current application, which allows interception of HTML5 web notifications.
|
|
9976
|
+
*
|
|
9977
|
+
* Secured by default, must be called from a WebContents with the NotificationManager.init permission.
|
|
9978
|
+
*
|
|
9979
|
+
* Only one NotificationManager can be active at a time, calls to `init` will fail otherwise.
|
|
9980
|
+
*
|
|
9981
|
+
* If a WebContents with the NotificationManager active reloads or is closed, it will be possible to create a new one.
|
|
9982
|
+
*
|
|
9983
|
+
* @example
|
|
9984
|
+
*
|
|
9985
|
+
* ```js
|
|
9986
|
+
* // From Provider context
|
|
9987
|
+
* const notificationManager = await fin.NotificationManager.init();
|
|
9988
|
+
* // NotificationManager is now active and will intercept all incoming notifications.
|
|
9989
|
+
* ```
|
|
9990
|
+
* @experimental
|
|
9991
|
+
*/
|
|
9905
9992
|
init: () => Promise<NotificationManagerInstance>;
|
|
9906
9993
|
}
|
|
9907
9994
|
|
|
@@ -9909,8 +9996,6 @@ declare type NotificationManagerPermissions = {
|
|
|
9909
9996
|
init: boolean;
|
|
9910
9997
|
};
|
|
9911
9998
|
|
|
9912
|
-
declare type NotificiationHandler = (event: WebNotificationInfo) => void;
|
|
9913
|
-
|
|
9914
9999
|
/* Excluded from this release type: NotRequested */
|
|
9915
10000
|
|
|
9916
10001
|
/**
|
|
@@ -10323,11 +10408,12 @@ declare namespace OpenFin {
|
|
|
10323
10408
|
RoutingInfo,
|
|
10324
10409
|
DownloadShelfOptions,
|
|
10325
10410
|
ViewShowAtOptions,
|
|
10411
|
+
WebNotificationProperties,
|
|
10412
|
+
WebNotificationInfo,
|
|
10326
10413
|
NotificationEvent,
|
|
10414
|
+
NotificationHandler,
|
|
10327
10415
|
NotificationManagerInstance,
|
|
10328
10416
|
NotificationManagerModule,
|
|
10329
|
-
WebNotificationInfo,
|
|
10330
|
-
WebNotificationProperties,
|
|
10331
10417
|
ExtensionInfo,
|
|
10332
10418
|
ServeRequest,
|
|
10333
10419
|
AppAssetServeRequest,
|
|
@@ -13097,6 +13183,13 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
13097
13183
|
apiPath: '.getOSInfo';
|
|
13098
13184
|
namespace: 'System';
|
|
13099
13185
|
};
|
|
13186
|
+
'launch-log-uploader': ApiCall<{
|
|
13187
|
+
options: OpenFin.LogUploaderOptions;
|
|
13188
|
+
}, void> & {
|
|
13189
|
+
secure: true;
|
|
13190
|
+
apiPath: '.launchLogUploader';
|
|
13191
|
+
namespace: 'System';
|
|
13192
|
+
};
|
|
13100
13193
|
'launch-external-process': ApiCall<OpenFin.ExternalProcessRequestType, OpenFin.Identity> & {
|
|
13101
13194
|
secure: true;
|
|
13102
13195
|
apiPath: '.launchExternalProcess';
|
|
@@ -13464,12 +13557,6 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
13464
13557
|
};
|
|
13465
13558
|
response: void;
|
|
13466
13559
|
};
|
|
13467
|
-
'launch-log-uploader': ApiCall<{
|
|
13468
|
-
options: OpenFin.LogUploaderOptions;
|
|
13469
|
-
}, void> & {
|
|
13470
|
-
apiPath: '.launchLogUploader';
|
|
13471
|
-
namespace: 'System';
|
|
13472
|
-
};
|
|
13473
13560
|
'dispatch-notification-event': {
|
|
13474
13561
|
request: {
|
|
13475
13562
|
notificationId: string;
|
|
@@ -16121,6 +16208,7 @@ declare type SystemPermissions = {
|
|
|
16121
16208
|
downloadAsset: boolean;
|
|
16122
16209
|
serveAsset: boolean;
|
|
16123
16210
|
enableNativeWindowIntegrationProvider: boolean;
|
|
16211
|
+
launchLogUploader: boolean;
|
|
16124
16212
|
};
|
|
16125
16213
|
|
|
16126
16214
|
/**
|
package/out/fdc3-api-public.d.ts
CHANGED
|
@@ -9752,6 +9752,12 @@ declare type MutableWindowOptions = {
|
|
|
9752
9752
|
/**
|
|
9753
9753
|
* Shows the window's icon in the taskbar.
|
|
9754
9754
|
*
|
|
9755
|
+
* @remarks
|
|
9756
|
+
* In Windows, setting `showTaskbarIcon` to false will cause the window to display on all virtual desktops.
|
|
9757
|
+
* In order to prevent this while keeping `showTaskbarIcon` false, pass the identity of the parent via the
|
|
9758
|
+
* `modalParentIdentity` (see {@link WindowCreationOptions}). This is useful for popups managed by
|
|
9759
|
+
* {@link Window._Window.showPopupWindow}.
|
|
9760
|
+
*
|
|
9755
9761
|
* @default true
|
|
9756
9762
|
*/
|
|
9757
9763
|
showTaskbarIcon: boolean;
|
|
@@ -9893,15 +9899,96 @@ declare type NotificationEvent = {
|
|
|
9893
9899
|
notificationId: string;
|
|
9894
9900
|
};
|
|
9895
9901
|
|
|
9902
|
+
declare type NotificationHandler = (notification: WebNotificationInfo) => void;
|
|
9903
|
+
|
|
9904
|
+
/**
|
|
9905
|
+
* NotificationManagers allow all {@link https://developer.mozilla.org/en-US/docs/Web/API/Notifications_API | HTML5 notifications} created in the application to be intercepted and dispatched.
|
|
9906
|
+
*
|
|
9907
|
+
* Please note, currently Notifications will only be intercepted if the following conditions are met:
|
|
9908
|
+
* - The source WebContents has the `notification` webAPI permission.
|
|
9909
|
+
* - The source WebContents is not a service worker.
|
|
9910
|
+
*
|
|
9911
|
+
* Service worker and push notifications are currently not supported.
|
|
9912
|
+
*
|
|
9913
|
+
* **See also** - {@link https://developer.mozilla.org/en-US/docs/Web/API/Notifications_API | Notification API (MDN)}
|
|
9914
|
+
*
|
|
9915
|
+
* @experimental This API is subject to change in future releases.
|
|
9916
|
+
*
|
|
9917
|
+
*/
|
|
9896
9918
|
declare class NotificationManagerInstance {
|
|
9897
9919
|
#private;
|
|
9898
|
-
|
|
9899
|
-
|
|
9920
|
+
/* Excluded from this release type: __constructor */
|
|
9921
|
+
/**
|
|
9922
|
+
* Sets the current handler for notifications. The provided function will be invoked whenever a WebContents successfully raises a notification.
|
|
9923
|
+
*
|
|
9924
|
+
* **Note**, only one handler can be used at a time, calling `setNotificationHandler` will replace any existing registered handler.
|
|
9925
|
+
*
|
|
9926
|
+
* @param handler The notification handler callback which will be invoked whenever a notification is created.
|
|
9927
|
+
*
|
|
9928
|
+
* @example
|
|
9929
|
+
*
|
|
9930
|
+
* ```typescript
|
|
9931
|
+
* const notificationManager = await fin.NotificationManager.init();
|
|
9932
|
+
* const handler = (notification) => {
|
|
9933
|
+
* console.log("Received the following notification", info);
|
|
9934
|
+
* }
|
|
9935
|
+
* await notificationManager.setNotificationHandler(handler);
|
|
9936
|
+
* ```
|
|
9937
|
+
*/
|
|
9938
|
+
setNotificationHandler: (handler: OpenFin.NotificationHandler) => Promise<void>;
|
|
9939
|
+
/**
|
|
9940
|
+
* Destroys the current NotificationManagerInstance.
|
|
9941
|
+
*
|
|
9942
|
+
* @example
|
|
9943
|
+
* ```typescript
|
|
9944
|
+
* await notificationManager.destroy();
|
|
9945
|
+
* ```
|
|
9946
|
+
*/
|
|
9900
9947
|
destroy: () => Promise<void>;
|
|
9901
|
-
|
|
9948
|
+
/**
|
|
9949
|
+
* Dispatches a Notification lifecycle event ('close' | 'click' | 'show').
|
|
9950
|
+
*
|
|
9951
|
+
* @param event Identifies the type of event to emit, and which `notificationId` to emit it for.
|
|
9952
|
+
*
|
|
9953
|
+
* @example
|
|
9954
|
+
* ```typescript
|
|
9955
|
+
* notificationManager.setNotificationHandler((notification) => {
|
|
9956
|
+
* await mockNotificationUi.showNotification(notification);
|
|
9957
|
+
* await notificationManager.dispatchNotificationEvent({
|
|
9958
|
+
* notificationId: notification.notificationId,
|
|
9959
|
+
* type: 'show
|
|
9960
|
+
* })
|
|
9961
|
+
* })
|
|
9962
|
+
* ```
|
|
9963
|
+
*
|
|
9964
|
+
* **See Also** - {@link https://developer.mozilla.org/en-US/docs/Web/API/Notification/click_event | Notification Click Event (MDN)}
|
|
9965
|
+
*
|
|
9966
|
+
* **See Also** - {@link https://developer.mozilla.org/en-US/docs/Web/API/Notification/close_event | Notification Close Event (MDN)}
|
|
9967
|
+
*
|
|
9968
|
+
* **See Also** - {@link https://developer.mozilla.org/en-US/docs/Web/API/Notification/show_event | Notification Show Event (MDN)}
|
|
9969
|
+
*/
|
|
9970
|
+
dispatch: (event: OpenFin.NotificationEvent) => Promise<void>;
|
|
9902
9971
|
}
|
|
9903
9972
|
|
|
9904
9973
|
declare class NotificationManagerModule extends Base {
|
|
9974
|
+
/**
|
|
9975
|
+
* Initializes a NotificationManager for the current application, which allows interception of HTML5 web notifications.
|
|
9976
|
+
*
|
|
9977
|
+
* Secured by default, must be called from a WebContents with the NotificationManager.init permission.
|
|
9978
|
+
*
|
|
9979
|
+
* Only one NotificationManager can be active at a time, calls to `init` will fail otherwise.
|
|
9980
|
+
*
|
|
9981
|
+
* If a WebContents with the NotificationManager active reloads or is closed, it will be possible to create a new one.
|
|
9982
|
+
*
|
|
9983
|
+
* @example
|
|
9984
|
+
*
|
|
9985
|
+
* ```js
|
|
9986
|
+
* // From Provider context
|
|
9987
|
+
* const notificationManager = await fin.NotificationManager.init();
|
|
9988
|
+
* // NotificationManager is now active and will intercept all incoming notifications.
|
|
9989
|
+
* ```
|
|
9990
|
+
* @experimental
|
|
9991
|
+
*/
|
|
9905
9992
|
init: () => Promise<NotificationManagerInstance>;
|
|
9906
9993
|
}
|
|
9907
9994
|
|
|
@@ -9909,8 +9996,6 @@ declare type NotificationManagerPermissions = {
|
|
|
9909
9996
|
init: boolean;
|
|
9910
9997
|
};
|
|
9911
9998
|
|
|
9912
|
-
declare type NotificiationHandler = (event: WebNotificationInfo) => void;
|
|
9913
|
-
|
|
9914
9999
|
/* Excluded from this release type: NotRequested */
|
|
9915
10000
|
|
|
9916
10001
|
/**
|
|
@@ -10323,11 +10408,12 @@ declare namespace OpenFin {
|
|
|
10323
10408
|
RoutingInfo,
|
|
10324
10409
|
DownloadShelfOptions,
|
|
10325
10410
|
ViewShowAtOptions,
|
|
10411
|
+
WebNotificationProperties,
|
|
10412
|
+
WebNotificationInfo,
|
|
10326
10413
|
NotificationEvent,
|
|
10414
|
+
NotificationHandler,
|
|
10327
10415
|
NotificationManagerInstance,
|
|
10328
10416
|
NotificationManagerModule,
|
|
10329
|
-
WebNotificationInfo,
|
|
10330
|
-
WebNotificationProperties,
|
|
10331
10417
|
ExtensionInfo,
|
|
10332
10418
|
ServeRequest,
|
|
10333
10419
|
AppAssetServeRequest,
|
|
@@ -13097,6 +13183,13 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
13097
13183
|
apiPath: '.getOSInfo';
|
|
13098
13184
|
namespace: 'System';
|
|
13099
13185
|
};
|
|
13186
|
+
'launch-log-uploader': ApiCall<{
|
|
13187
|
+
options: OpenFin.LogUploaderOptions;
|
|
13188
|
+
}, void> & {
|
|
13189
|
+
secure: true;
|
|
13190
|
+
apiPath: '.launchLogUploader';
|
|
13191
|
+
namespace: 'System';
|
|
13192
|
+
};
|
|
13100
13193
|
'launch-external-process': ApiCall<OpenFin.ExternalProcessRequestType, OpenFin.Identity> & {
|
|
13101
13194
|
secure: true;
|
|
13102
13195
|
apiPath: '.launchExternalProcess';
|
|
@@ -13464,12 +13557,6 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
13464
13557
|
};
|
|
13465
13558
|
response: void;
|
|
13466
13559
|
};
|
|
13467
|
-
'launch-log-uploader': ApiCall<{
|
|
13468
|
-
options: OpenFin.LogUploaderOptions;
|
|
13469
|
-
}, void> & {
|
|
13470
|
-
apiPath: '.launchLogUploader';
|
|
13471
|
-
namespace: 'System';
|
|
13472
|
-
};
|
|
13473
13560
|
'dispatch-notification-event': {
|
|
13474
13561
|
request: {
|
|
13475
13562
|
notificationId: string;
|
|
@@ -16121,6 +16208,7 @@ declare type SystemPermissions = {
|
|
|
16121
16208
|
downloadAsset: boolean;
|
|
16122
16209
|
serveAsset: boolean;
|
|
16123
16210
|
enableNativeWindowIntegrationProvider: boolean;
|
|
16211
|
+
launchLogUploader: boolean;
|
|
16124
16212
|
};
|
|
16125
16213
|
|
|
16126
16214
|
/**
|
package/out/fdc3-api.d.ts
CHANGED
|
@@ -10065,6 +10065,12 @@ declare type MutableWindowOptions = {
|
|
|
10065
10065
|
/**
|
|
10066
10066
|
* Shows the window's icon in the taskbar.
|
|
10067
10067
|
*
|
|
10068
|
+
* @remarks
|
|
10069
|
+
* In Windows, setting `showTaskbarIcon` to false will cause the window to display on all virtual desktops.
|
|
10070
|
+
* In order to prevent this while keeping `showTaskbarIcon` false, pass the identity of the parent via the
|
|
10071
|
+
* `modalParentIdentity` (see {@link WindowCreationOptions}). This is useful for popups managed by
|
|
10072
|
+
* {@link Window._Window.showPopupWindow}.
|
|
10073
|
+
*
|
|
10068
10074
|
* @default true
|
|
10069
10075
|
*/
|
|
10070
10076
|
showTaskbarIcon: boolean;
|
|
@@ -10219,15 +10225,99 @@ declare type NotificationEvent = {
|
|
|
10219
10225
|
notificationId: string;
|
|
10220
10226
|
};
|
|
10221
10227
|
|
|
10228
|
+
declare type NotificationHandler = (notification: WebNotificationInfo) => void;
|
|
10229
|
+
|
|
10230
|
+
/**
|
|
10231
|
+
* NotificationManagers allow all {@link https://developer.mozilla.org/en-US/docs/Web/API/Notifications_API | HTML5 notifications} created in the application to be intercepted and dispatched.
|
|
10232
|
+
*
|
|
10233
|
+
* Please note, currently Notifications will only be intercepted if the following conditions are met:
|
|
10234
|
+
* - The source WebContents has the `notification` webAPI permission.
|
|
10235
|
+
* - The source WebContents is not a service worker.
|
|
10236
|
+
*
|
|
10237
|
+
* Service worker and push notifications are currently not supported.
|
|
10238
|
+
*
|
|
10239
|
+
* **See also** - {@link https://developer.mozilla.org/en-US/docs/Web/API/Notifications_API | Notification API (MDN)}
|
|
10240
|
+
*
|
|
10241
|
+
* @experimental This API is subject to change in future releases.
|
|
10242
|
+
*
|
|
10243
|
+
*/
|
|
10222
10244
|
declare class NotificationManagerInstance {
|
|
10223
10245
|
#private;
|
|
10246
|
+
/**
|
|
10247
|
+
* @internal
|
|
10248
|
+
*/
|
|
10224
10249
|
constructor(wire: Transport, id: string);
|
|
10225
|
-
|
|
10250
|
+
/**
|
|
10251
|
+
* Sets the current handler for notifications. The provided function will be invoked whenever a WebContents successfully raises a notification.
|
|
10252
|
+
*
|
|
10253
|
+
* **Note**, only one handler can be used at a time, calling `setNotificationHandler` will replace any existing registered handler.
|
|
10254
|
+
*
|
|
10255
|
+
* @param handler The notification handler callback which will be invoked whenever a notification is created.
|
|
10256
|
+
*
|
|
10257
|
+
* @example
|
|
10258
|
+
*
|
|
10259
|
+
* ```typescript
|
|
10260
|
+
* const notificationManager = await fin.NotificationManager.init();
|
|
10261
|
+
* const handler = (notification) => {
|
|
10262
|
+
* console.log("Received the following notification", info);
|
|
10263
|
+
* }
|
|
10264
|
+
* await notificationManager.setNotificationHandler(handler);
|
|
10265
|
+
* ```
|
|
10266
|
+
*/
|
|
10267
|
+
setNotificationHandler: (handler: OpenFin.NotificationHandler) => Promise<void>;
|
|
10268
|
+
/**
|
|
10269
|
+
* Destroys the current NotificationManagerInstance.
|
|
10270
|
+
*
|
|
10271
|
+
* @example
|
|
10272
|
+
* ```typescript
|
|
10273
|
+
* await notificationManager.destroy();
|
|
10274
|
+
* ```
|
|
10275
|
+
*/
|
|
10226
10276
|
destroy: () => Promise<void>;
|
|
10227
|
-
|
|
10277
|
+
/**
|
|
10278
|
+
* Dispatches a Notification lifecycle event ('close' | 'click' | 'show').
|
|
10279
|
+
*
|
|
10280
|
+
* @param event Identifies the type of event to emit, and which `notificationId` to emit it for.
|
|
10281
|
+
*
|
|
10282
|
+
* @example
|
|
10283
|
+
* ```typescript
|
|
10284
|
+
* notificationManager.setNotificationHandler((notification) => {
|
|
10285
|
+
* await mockNotificationUi.showNotification(notification);
|
|
10286
|
+
* await notificationManager.dispatchNotificationEvent({
|
|
10287
|
+
* notificationId: notification.notificationId,
|
|
10288
|
+
* type: 'show
|
|
10289
|
+
* })
|
|
10290
|
+
* })
|
|
10291
|
+
* ```
|
|
10292
|
+
*
|
|
10293
|
+
* **See Also** - {@link https://developer.mozilla.org/en-US/docs/Web/API/Notification/click_event | Notification Click Event (MDN)}
|
|
10294
|
+
*
|
|
10295
|
+
* **See Also** - {@link https://developer.mozilla.org/en-US/docs/Web/API/Notification/close_event | Notification Close Event (MDN)}
|
|
10296
|
+
*
|
|
10297
|
+
* **See Also** - {@link https://developer.mozilla.org/en-US/docs/Web/API/Notification/show_event | Notification Show Event (MDN)}
|
|
10298
|
+
*/
|
|
10299
|
+
dispatch: (event: OpenFin.NotificationEvent) => Promise<void>;
|
|
10228
10300
|
}
|
|
10229
10301
|
|
|
10230
10302
|
declare class NotificationManagerModule extends Base {
|
|
10303
|
+
/**
|
|
10304
|
+
* Initializes a NotificationManager for the current application, which allows interception of HTML5 web notifications.
|
|
10305
|
+
*
|
|
10306
|
+
* Secured by default, must be called from a WebContents with the NotificationManager.init permission.
|
|
10307
|
+
*
|
|
10308
|
+
* Only one NotificationManager can be active at a time, calls to `init` will fail otherwise.
|
|
10309
|
+
*
|
|
10310
|
+
* If a WebContents with the NotificationManager active reloads or is closed, it will be possible to create a new one.
|
|
10311
|
+
*
|
|
10312
|
+
* @example
|
|
10313
|
+
*
|
|
10314
|
+
* ```js
|
|
10315
|
+
* // From Provider context
|
|
10316
|
+
* const notificationManager = await fin.NotificationManager.init();
|
|
10317
|
+
* // NotificationManager is now active and will intercept all incoming notifications.
|
|
10318
|
+
* ```
|
|
10319
|
+
* @experimental
|
|
10320
|
+
*/
|
|
10231
10321
|
init: () => Promise<NotificationManagerInstance>;
|
|
10232
10322
|
}
|
|
10233
10323
|
|
|
@@ -10235,8 +10325,6 @@ declare type NotificationManagerPermissions = {
|
|
|
10235
10325
|
init: boolean;
|
|
10236
10326
|
};
|
|
10237
10327
|
|
|
10238
|
-
declare type NotificiationHandler = (event: WebNotificationInfo) => void;
|
|
10239
|
-
|
|
10240
10328
|
/**
|
|
10241
10329
|
* @internal
|
|
10242
10330
|
*
|
|
@@ -10654,11 +10742,12 @@ declare namespace OpenFin {
|
|
|
10654
10742
|
RoutingInfo,
|
|
10655
10743
|
DownloadShelfOptions,
|
|
10656
10744
|
ViewShowAtOptions,
|
|
10745
|
+
WebNotificationProperties,
|
|
10746
|
+
WebNotificationInfo,
|
|
10657
10747
|
NotificationEvent,
|
|
10748
|
+
NotificationHandler,
|
|
10658
10749
|
NotificationManagerInstance,
|
|
10659
10750
|
NotificationManagerModule,
|
|
10660
|
-
WebNotificationInfo,
|
|
10661
|
-
WebNotificationProperties,
|
|
10662
10751
|
ExtensionInfo,
|
|
10663
10752
|
ServeRequest,
|
|
10664
10753
|
AppAssetServeRequest,
|
|
@@ -13511,6 +13600,13 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
13511
13600
|
apiPath: '.getOSInfo';
|
|
13512
13601
|
namespace: 'System';
|
|
13513
13602
|
};
|
|
13603
|
+
'launch-log-uploader': ApiCall<{
|
|
13604
|
+
options: OpenFin.LogUploaderOptions;
|
|
13605
|
+
}, void> & {
|
|
13606
|
+
secure: true;
|
|
13607
|
+
apiPath: '.launchLogUploader';
|
|
13608
|
+
namespace: 'System';
|
|
13609
|
+
};
|
|
13514
13610
|
'launch-external-process': ApiCall<OpenFin.ExternalProcessRequestType, OpenFin.Identity> & {
|
|
13515
13611
|
secure: true;
|
|
13516
13612
|
apiPath: '.launchExternalProcess';
|
|
@@ -13878,12 +13974,6 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
13878
13974
|
};
|
|
13879
13975
|
response: void;
|
|
13880
13976
|
};
|
|
13881
|
-
'launch-log-uploader': ApiCall<{
|
|
13882
|
-
options: OpenFin.LogUploaderOptions;
|
|
13883
|
-
}, void> & {
|
|
13884
|
-
apiPath: '.launchLogUploader';
|
|
13885
|
-
namespace: 'System';
|
|
13886
|
-
};
|
|
13887
13977
|
'dispatch-notification-event': {
|
|
13888
13978
|
request: {
|
|
13889
13979
|
notificationId: string;
|
|
@@ -16541,6 +16631,7 @@ declare type SystemPermissions = {
|
|
|
16541
16631
|
downloadAsset: boolean;
|
|
16542
16632
|
serveAsset: boolean;
|
|
16543
16633
|
enableNativeWindowIntegrationProvider: boolean;
|
|
16634
|
+
launchLogUploader: boolean;
|
|
16544
16635
|
};
|
|
16545
16636
|
|
|
16546
16637
|
/**
|